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

document the return types of fieldname and fieldnames #55259

Merged
merged 3 commits into from
Aug 1, 2024

Conversation

nsajko
Copy link
Contributor

@nsajko nsajko commented Jul 26, 2024

No description provided.

@nsajko nsajko added the docs This change adds or pertains to documentation label Jul 26, 2024
@tecosaur
Copy link
Contributor

How about the good ol' func(args...) -> RetType pattern for the docstrings?

@nsajko
Copy link
Contributor Author

nsajko commented Jul 26, 2024

The current PR gives more information than that, though. The return type is documented conditional on the argument. So what you propose would be a loss of information relative to the current PR?

Also I don't like that pattern because it's not Julia syntax.

@nsajko
Copy link
Contributor Author

nsajko commented Jul 28, 2024

bump

base/reflection.jl Outdated Show resolved Hide resolved
base/reflection.jl Outdated Show resolved Hide resolved
@fingolfin fingolfin merged commit 5092379 into JuliaLang:master Aug 1, 2024
7 checks passed
@nsajko nsajko deleted the doc_fieldname branch August 1, 2024 09:32
lazarusA pushed a commit to lazarusA/julia that referenced this pull request Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants