Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Fix errors more prettily #127

Merged
merged 1 commit into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/adc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ impl ADCLine {

/// Initialize an ADC line identified by the line number it is assigned on the board
///
/// Safety: See [Self::init()]
/// Safety: See [.init()][Self::init()]
pub unsafe fn from_number(line: u32) -> Result<Self, i32> {
let line = riot_sys::macro_ADC_LINE(line);
Self::init(line)
Expand Down
2 changes: 1 addition & 1 deletion src/async_helpers.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ use core::future::Future;
/// While this can legally be implemented without unsafe, practical use will require unsafe, and
/// that requires sticking to the rules:
///
/// * Whenever [Self::poll()] is called, do whatever the future needs to do after having been awoken. If
/// * Whenever [.poll()][Self::poll()] is called, do whatever the future needs to do after having been awoken. If
/// this returns [core::task::Poll::Pending] (and the future wants to be polled ever again), it
/// must then pass on the `arg` to some RIOT callback setter together with a static function of a
/// suitable signature. Conventionally, that function is called `Self::callback()`.
Expand Down
2 changes: 1 addition & 1 deletion src/gpio/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ impl GPIO {
/// # }
/// ```
///
/// See [Self::from_c()] for safety constraints.
/// See [.from_c()][Self::from_c()] for safety constraints.
pub fn from_port_and_pin(port: u32, pin: u32) -> Option<Self> {
Self::from_c(unsafe { riot_sys::macro_GPIO_PIN(port, pin) })
}
Expand Down
Loading