mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-27 14:04:56 +01:00
Code Issues Projects Releases Packages Wiki Activity

CI: rtic-monotonics: systick not always in scope

Browse source 
Links are checked during compilation, and to not
make it overly complex remove the link

```
error: unresolved link to `systick`
 --> rtic-monotonics/src/lib.rs:7:11
  |
7 | //! The [`systick`] monotonic works on all cortex-M parts, and requires that the feature `cortex-m-systick` is enabled.
  |           ^^^^^^^ no item named `systick` in scope
  |
  = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
  = note: `-D rustdoc::broken-intra-doc-links` implied by `-D warnings`
  = help: to override `-D warnings` add `#[allow(rustdoc::broken_intra_doc_links)]`

error: could not document `rtic-monotonics`
```
This commit is contained in:
Henrik Tjäder 2023-11-08 21:39:12 +01:00 committed by Emil Fresk
parent 4425b76c6f
commit ea8b5b6c33
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
rtic-monotonics/src/lib.rs
View file

@ -4,7 +4,7 @@
//! To enable the implementations, you must enable a feature for the specific MCU you're targeting. //! To enable the implementations, you must enable a feature for the specific MCU you're targeting.
//! //!
//! # Cortex-M Systick //! # Cortex-M Systick
//! The [`systick`] monotonic works on all cortex-M parts, and requires that the feature `cortex-m-systick` is enabled. //! The `systick` monotonic works on all cortex-M parts, and requires that the feature `cortex-m-systick` is enabled.
//! //!
//! # RP2040 //! # RP2040
//! The RP2040 monotonics require that the `rp2040` feature is enabled. //! The RP2040 monotonics require that the `rp2040` feature is enabled.