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

Document @generated #19300

Closed
andyferris opened this issue Nov 11, 2016 · 2 comments
Closed

Document @generated #19300

andyferris opened this issue Nov 11, 2016 · 2 comments
Labels
needs docs Documentation for this change is required

Comments

@andyferris
Copy link
Member

A docstring for @generated listing its capabilities and particularly its restrictions would be quite useful.
@ViralBShah ViralBShah added the needs docs Documentation for this change is required label Nov 11, 2016
@andyferris andyferris mentioned this issue Nov 12, 2016
Closed
@oxinabox oxinabox mentioned this issue Apr 12, 2017
Closed
@oxinabox
Copy link
Contributor

Would it suffice to copy-paste the top of:
https://docs.julialang.org/en/latest/manual/metaprogramming.html#Generated-functions-1
Up to the first example,

into the docstring for @generated?

I feel like that would get most of the way there.
Maybe a little rewritting to be a bit more terse.

@laborg
Copy link
Contributor

laborg commented Feb 2, 2022

Can be closed - the docstring for @generated has been added in #27949

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
needs docs Documentation for this change is required
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@ViralBShah @andyferris @oxinabox @laborg @fredrikekre