Skip to content

Commit

Permalink
fix(docs): don't fail rustdoc due to termion (#503)
Browse files Browse the repository at this point in the history
Windows cannot compile termion, so it is not included in the docs.
Rustdoc will fail if it cannot find a link, so the docs fail to build
on windows.

This replaces the link to TermionBackend with one that does not fail
during checks.

Fixes #498
  • Loading branch information
joshka committed Sep 15, 2023
1 parent 638d596 commit 0c7d547
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@
//! backend being used, and developers should consult the specific backend's documentation to
//! understand how it implements mouse capture.
//!
//! [`TermionBackend`]: termion/struct.TermionBackend.html
//! [`Terminal`]: crate::terminal::Terminal
//! [Crossterm]: https://crates.io/crates/crossterm
//! [Termion]: https://crates.io/crates/termion
Expand Down

0 comments on commit 0c7d547

Please sign in to comment.