Clean up re-exports and make small improvements to documentation #607
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've additionally collapsed all the PRs for ESP32-H2 support into a single CHANGELOG entry. I can revert this if people are not a fan, but I don't think they all need to be split up personally. |
MabezDev
reviewed
Jun 21, 2023
jessebraham
force-pushed
the
feature/docs
branch
2 times, most recently
from
de8dba4 to
d1ff007
Compare
jessebraham
force-pushed
the
feature/docs
branch
from
d1ff007 to
714e1d0
Compare
MabezDev
pushed a commit
that referenced
this pull request
Jul 12, 2023
* Create issue_handler.yml * No longer re-export `embedded-hal`, hide exported macros in documentation * Add simple package-level documentation for each HAL package * Clean up/simplify re-exports * Fix the examples that I broke * Ensure top-level modules/types/functions have doc comments * Update CHANGELOG * Re-export the `soc::psram` module where available --------- Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com>
playfulFence
pushed a commit
to playfulFence/esp-hal
that referenced
this pull request
Sep 26, 2023
…-rs#607) * Create issue_handler.yml * No longer re-export `embedded-hal`, hide exported macros in documentation * Add simple package-level documentation for each HAL package * Clean up/simplify re-exports * Fix the examples that I broke * Ensure top-level modules/types/functions have doc comments * Update CHANGELOG * Re-export the `soc::psram` module where available --------- Co-authored-by: Sergio Gasquez Arcos <sergio.gasquez@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR got a little off the rails, so sorry for mixing different changes.
Simplifies our re-exports (both in the chip-specific HALs and in
esp-hal-common) and hides a number of exported macros which should not be displayed in documentation.Additionally adds package-level docs for each chip-specific HAL, and adds some basic module/type doc strings so that at least the landing page for our packages on docs.rs looks nice 😁
@playfulFence, @SergioGasquez, and I will be working on improving documentation moving forward.