docs: a few minor doc improvements #860
Conversation
There was a problem hiding this comment.
I appreciate your recent interest and PRs, @nyurik ! The currently open three PRs are for relatively small changes, it would help if you could put them in to one PR - maybe using different commits to separate the different type of change.
| //! ## Features | ||
| //! | ||
| //! - Converting between pin modes no longer requires access to the `Port` type. | ||
| //! - Converting between pin modes no longer requires access to the |
There was a problem hiding this comment.
Let's just get rid of this whole reference to the old GPIO module - it was useful when we had two GPIO versions in the HAL but now only of historical interest
| //! A: EnumOne, | ||
| //! B: EnumTwo, | ||
| //! { | ||
| //! struct Container<A: EnumOne, B: EnumTwo> { |
There was a problem hiding this comment.
Are this and the other changes to eliminate the where clauses personal preference, or suggested by a tool? I feel the old way is more illustrative, and since they are in docstrings this change seems to be moving in the wrong direction.
|
@ianrrees , thx for such a quick review! The I am happy to make a bigger single PR - some projects simply require smaller and easier to review changes - e.g. if i am editing the docs, i shouldn't change the cargo.toml - as that may hide a bug - but i will be happy to merge all PRs into one |
|
closing in favor of #872 |
Summary
Just a few cleanups - trying to make things a bit more readable