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

Confusing Documentation around named parameters #2359

Closed
barcharcraz opened this issue Oct 5, 2018 · 1 comment
Closed

Confusing Documentation around named parameters #2359

barcharcraz opened this issue Oct 5, 2018 · 1 comment
Labels
docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.

Comments

@barcharcraz
Copy link

barcharcraz commented Oct 5, 2018

The problem

I was reading the docs at https://docs.perl6.org/language/objects#Object_construction and I found the signature of BUILD confusing. I also noticed that https://docs.perl6.org/language/functions#Arguments does not really talk about the named parameter syntax much.

Suggestions

A link to https://docs.perl6.org/language/functions#Arguments could be good from the object construction phase. It would also be good to have some documentation on how named parameters work and how they differ from pair constructors. It's not clear if they are a special syntax or a special case of something else.

@JJ JJ added docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc. labels Oct 6, 2018
@JJ
Copy link
Contributor

JJ commented Oct 6, 2018

You mean in the way it can define alias for attributes? I guess it wouldn't hurt to link that. Thanks for the report.

@JJ JJ closed this as completed in fda476f Oct 20, 2018
JJ added a commit that referenced this issue Oct 20, 2018
Fix #2359 Add link to arguments in Objects
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation issue (primary issue type) update part of "docs" - indicates this is an update for an existing section; rewrite, clarification, etc.
Projects
None yet
Development

No branches or pull requests

2 participants