Skip to content
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.

Sign up for GitHub

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

Jump to bottom

include macros in Docs.undocumented_names #52727

Closed
wants to merge 2 commits into from
Closed

include macros in Docs.undocumented_names #52727

wants to merge 2 commits into from

Conversation

stevengj
Copy link
Member

@stevengj stevengj commented Jan 4, 2024 •
edited
Loading

@stevengj stevengj added docsystem The documentation building system bugfix This change fixes an existing bug labels Jan 4, 2024
@jariji
Copy link
Contributor

jariji commented Jan 4, 2024

LGTM

This was referenced Jan 4, 2024
Merged
Open
@stevengj
Copy link
Member Author

stevengj commented Jan 4, 2024

CI failures look unrelated, should be good to merge @LilithHafner.

@LilithHafner
Copy link
Member

This still has some strange behaviors/bugs

  • undocumented_names() does not include deprecated names while undocumented_names(all=true) does
  • it is documented to work based on export status but actually works based on publicity
  • it doesn't return the names of infix operators

See #52413 (comment) for an alternative semantic.

stevengj
stevengj commented Jan 4, 2024
View reviewed changes
base/docs/Docs.jl Outdated Show resolved Hide resolved
@stevengj
Copy link
Member Author

stevengj commented Jan 4, 2024

Closed in favor of #52743

@stevengj stevengj closed this Jan 4, 2024
@DilumAluthge DilumAluthge deleted the undoc_macros branch January 4, 2024 16:05
stevengj added a commit that referenced this pull request Jan 14, 2024
@stevengj @LilithHafner
add tests for undocumented symbols (#52723)
25c4166 
Following #52413 by @jariji and the discussion in #51174, this adds
tests to ensure that there are no undocumented *(= lacking docstrings)*
public symbols in any documented module.

Many of the tests are broken — we have a lot of undocumented exports. In
such cases I added both a `@test_broken` and a `@test` to ensure that
there are no additional regressions added in the future.

~~(This PR may have to be updated when
#52413 (comment) is
fixed, i.e. when ~~#52727~~ #52743 is merged.)~~ Has been updated.

---------

Co-authored-by: Lilith Orion Hafner <lilithhafner@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
bugfix This change fixes an existing bug docsystem The documentation building system
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevengj @jariji @LilithHafner