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.

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

Rename Docs.undocumented_names to Docs.names_without_docstring #52726

Closed
wants to merge 2 commits into from

Conversation

DilumAluthge
Copy link
Member

This PR renames Docs.undocumented_names to Docs.names_without_docstring. The rationale behind this PR is the same as that of #52724.

I made this PR and #52724 as two separate PRs, but if desired I can combine them into a single PR.


Note: Docs.undocumented_names was introduced in #52413 (1b183b9), which hasn't made it into a release branch yet.

@stevengj
Copy link
Member

stevengj commented Jan 4, 2024

I'm not sure I agree, for the reason explained in #52724 (comment) — this function is in the context of the Docs module, which is exclusively about docstrings.

(In contrast, a Documenter.undocumented_names function might check the manual.)

@DilumAluthge
Copy link
Member Author

#52413 (comment)

@DilumAluthge DilumAluthge deleted the dpa/names_without_docstring branch January 4, 2024 03:44
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