Skip to content

Commit cb0e697

Browse files
authored
style: fix broken rustdoc comment (#9329)
* ci: lint for broken inline code / backticks Enables the rustdoc "unescaped_backticks" lint[1] at warn level. Unfortunately this only covers "prod" code, so it doesn't catch the actual broken backticks in the test code! [1]: https://doc.rust-lang.org/rustdoc/lints.html#unescaped_backticks * style: remove spurious backtick This breaks the rustdoc rendering. * chore: apply rustdoc lint to workspace Lint the entire workspace by specifying it in Cargo.toml.
1 parent c847b96 commit cb0e697

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ rust_2018_compatibility = "warn"
1919
rust_2021_compatibility = "warn"
2020
unused = "warn"
2121

22+
[workspace.lints.rustdoc]
23+
unescaped_backticks = "warn"
24+
2225
[workspace.lints.clippy]
2326
dbg_macro = "warn"
2427
todo = "warn"

src/tests/util/test_app.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ impl TestApp {
116116
}
117117

118118
/// Create a new user with a verified email address in the database
119-
/// (`<username>@example.com``) and return a mock user session.
119+
/// (`<username>@example.com`) and return a mock user session.
120120
///
121121
/// This method updates the database directly
122122
pub fn db_new_user(&self, username: &str) -> MockCookieUser {

0 commit comments

Comments
 (0)