Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

implement function_now_doc_hidden lint #594

Merged
merged 4 commits into from
Dec 5, 2023
Merged

implement function_now_doc_hidden lint #594

merged 4 commits into from
Dec 5, 2023

Conversation

u9g
Copy link
Contributor

@u9g u9g commented Dec 5, 2023

Implements a lint to catch functions that are public and have just had #[doc(hidden)] added to them.

checks the fourth checkmark on #578 (comment)

obi1kenobi
obi1kenobi reviewed Dec 5, 2023
View reviewed changes
Copy link
Owner

@obi1kenobi obi1kenobi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Good idea on testing the constant-which-happens-to-be-a-function case. Unfortunately, the const wasn't public so the test didn't quite do what it said it would. I suggested a fix, otherwise this is ready to merge 🎉

test_crates/function_now_doc_hidden/new/src/lib.rs Outdated Show resolved Hide resolved
test_crates/function_now_doc_hidden/old/src/lib.rs Outdated Show resolved Hide resolved
@obi1kenobi obi1kenobi mentioned this pull request Dec 5, 2023
Open
20 tasks
obi1kenobi
obi1kenobi approved these changes Dec 5, 2023
View reviewed changes
Copy link
Owner

@obi1kenobi obi1kenobi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great test cases!

@obi1kenobi obi1kenobi merged commit 2588511 into obi1kenobi:main Dec 5, 2023
32 checks passed
@u9g u9g deleted the add_function_now_doc_hidden_lint branch December 5, 2023 21:20
@obi1kenobi obi1kenobi mentioned this pull request Feb 18, 2024
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@obi1kenobi obi1kenobi obi1kenobi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@u9g @obi1kenobi