Skip to content

style: fix broken rustdoc comment #9329

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

Merged
merged 3 commits into from
Aug 24, 2024
Merged

Conversation

domodwyer
Copy link
Contributor

Cleans up the bad comment formatting I introduced in #9322, and enables a rustdoc lint to try and catch repeats in the future.


  • ci: lint for broken inline code / backticks (559b51b)

    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 (5c34d66)

    This breaks the rustdoc rendering.
    

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
This breaks the rustdoc rendering.
Copy link

codecov bot commented Aug 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.17%. Comparing base (c847b96) to head (a3cf0a6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #9329   +/-   ##
=======================================
  Coverage   89.17%   89.17%           
=======================================
  Files         282      282           
  Lines       28913    28913           
=======================================
  Hits        25782    25782           
  Misses       3131     3131           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Lint the entire workspace by specifying it in Cargo.toml.
@Turbo87 Turbo87 merged commit cb0e697 into rust-lang:main Aug 24, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants