Skip to content

Commit ef1b3cf

Browse files
authored
uart: minor docs improvements (#3216)
* uart: docs improvement, re-shuffle and merge impl blocks * Add a note into developer-guidelines
1 parent 154f320 commit ef1b3cf

File tree

2 files changed

+531
-532
lines changed

2 files changed

+531
-532
lines changed

documentation/DEVELOPER-GUIDELINES.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,11 @@ In general, the [Rust API Guidelines](https://rust-lang.github.io/api-guidelines
102102
- When marking an API as `unstable`:
103103
- Prefer to use `#[instability::unstable]`.
104104
- Use the attribute on each public function instead of inherent impl blocks.
105+
- The documentation should contain no more than three primary impl blocks (excluding trait implementations):
106+
- Blocking: Should be listed first, as it serves as the entry point for creating most drivers.
107+
- Async: Should appear second in the documentation.
108+
- Both: A combined impl block for both Blocking and Async.
109+
- Methods inside the impl blocks should be grouped by functionality.
105110

106111
## Driver implementation
107112

0 commit comments

Comments
 (0)