Skip to content

Commit

Permalink
uart: minor docs improvements (#3216)
Browse files Browse the repository at this point in the history
* uart: docs improvement, re-shuffle and merge impl blocks

* Add a note into developer-guidelines
  • Loading branch information
JurajSadel authored Mar 5, 2025
1 parent 154f320 commit ef1b3cf
Show file tree
Hide file tree
Showing 2 changed files with 531 additions and 532 deletions.
5 changes: 5 additions & 0 deletions documentation/DEVELOPER-GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ In general, the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines
- When marking an API as `unstable`:
- Prefer to use `#[instability::unstable]`.
- Use the attribute on each public function instead of inherent impl blocks.
- The documentation should contain no more than three primary impl blocks (excluding trait implementations):
- Blocking: Should be listed first, as it serves as the entry point for creating most drivers.
- Async: Should appear second in the documentation.
- Both: A combined impl block for both Blocking and Async.
- Methods inside the impl blocks should be grouped by functionality.

## Driver implementation

Expand Down
Loading

0 comments on commit ef1b3cf

Please sign in to comment.