Skip to content

Commit

Permalink
Fix links in docs and deny rustdoc warnings in CI
Browse files Browse the repository at this point in the history
  • Loading branch information
oxalica committed Aug 7, 2023
1 parent eeebdf3 commit 103a3c3
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ jobs:
uses: dtolnay/rust-toolchain@clippy
- name: Rustdoc
env:
RUSTDOCFLAGS: --cfg docsrs
RUSTDOCFLAGS: --cfg docsrs -Dwarnings
run: cargo doc --all-features
6 changes: 4 additions & 2 deletions src/router.rs
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,8 @@ where
/// There can only be a single catch-all notification handler. New ones replace old ones.
///
/// The default handler is to do nothing for methods starting with `$/`, and break the main
/// loop with [`Error::Routing`] for other methods. Typically notifications are critical and
/// loop with [`Error::Routing`][crate::Error::Routing] for other methods. Typically
/// notifications are critical and
/// losing them can break state synchronization, easily leading to catastrophic failures after
/// incorrect incremental changes.
pub fn unhandled_notification(
Expand All @@ -187,7 +188,8 @@ where
///
/// There can only be a single catch-all event handler. New ones replace old ones.
///
/// The default handler is to break the main loop with [`Error::Routing`]. Since events are
/// The default handler is to break the main loop with
/// [`Error::Routing`][crate::Error::Routing]. Since events are
/// emitted internally, mishandling are typically logic errors.
pub fn unhandled_event(
&mut self,
Expand Down

0 comments on commit 103a3c3

Please sign in to comment.