Hide generated items in documentation#309
Merged
la10736 merged 2 commits intola10736:masterfrom May 8, 2025
Merged
Conversation
When the `missing_docs` lint is enabled in a crate that uses `rstest` then
any public `#[fixture]`s generate lint errors ("missing documentation for a struct"
and "missing documentation for an associated function").
Use `#[doc(hidden)]` to hide these autogenerated items in documentation.
Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>
Owner
|
Thanks, for your contribution. I'll take a look ASAP... But my ASAP could not be so AS SOON 😢 |
Owner
Ok, it's quite simple. I can do it. |
la10736
reviewed
May 7, 2025
Owner
la10736
left a comment
There was a problem hiding this comment.
It's ok for me, but can you add a E2E test to check it?
Contributor
Author
Great, thanks! Please check if the tests are in correct place. I've tested the tests by removing the lints and the fixes to the |
la10736
approved these changes
May 8, 2025
Owner
la10736
left a comment
There was a problem hiding this comment.
LGTM, Thanks again. I'll just wait the CI before merge it
Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>
4ca8eeb to
66038f6
Compare
Owner
|
Thanks again |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When the
missing_docslint is enabled in a crate that usesrstestthen any public#[fixture]s generate lint errors ("missing documentation for a struct" and "missing documentation for an associated function").Use
#[doc(hidden)]to hide these autogenerated items in documentation.Just in case anyone has a better idea I'm all ears (e.g. adding some documentation to these items, or allowing missing_docs lint).
(For context, here is the original issue that sparked this PR: https://gitlab.archlinux.org/archlinux/signstar/-/merge_requests/230/diffs#note_268412)
Thanks and have a nice day! 👋