Documentation fixes #668
Documentation fixes #668
Conversation
|
CI failure is spurious: I don't think this PR warrants a changelog entry so that's also red. |
| # Ensure documentation can be built (requires a chip feature!) | ||
| - name: rustdoc | ||
| run: cd esp-hal-smartled/ && cargo doc --features=esp32c3 | ||
| run: cd esp-hal-smartled/ && cargo doc --features=esp32c3,esp-hal-common/eh1 |
There was a problem hiding this comment.
I thought in your other PR we determined this wasn't needed? Or am I missing something here?
There was a problem hiding this comment.
No, no, this is needed so that the eh1-specific links in the common crate don't throw warnings. It was just in the wrong place in that PR.
There was a problem hiding this comment.
Oh I see how my comment was misleading. A specific example of a warning fixed by the feature can be seen here. To be fair, a proper solution would have been making the documentation conditional on the feature, but I don't think that would have been worth the complexity.
* Rustdoc improvements * Format efuse bracketed names as code * Fix SPI docs
3 participants
Thank you!
Thank you for your contribution.
Please make sure that your submission includes the following:
Must
errorsorwarnings.cargo fmtwas run.CHANGELOG.mdin the proper section.Nice to have
This PR is taken from #666 and fixes broken links and other warnings rustdoc may dislike. I've added the
eh1feature to the rustdoc checks where it makes sense, so that the CI will not generate warnings, even though that is largely ineffective.The PR also changes efuse docs a bit, to both improve readability and to fix the markdown syntax.