Lint/check for "Arguments" section of rustdoc

Is there a way to check if the rustdoc for a pub fn has an # Arguments section and/or all the parameters are documented.

There is a Clippy pedantic lint called clippy::missing_panics_doc that does something similar for # Panics sections.

This functionality doesn't exist in rustc, clippy or any "official" Rust tools because there isn't a standardized way of documenting function arguments in Rust, nor is it commonly done. You can see this GitHub Issue for some background.

2 Likes

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.