Revise and add to Attribute's documentation #3441
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JJ
requested changes
May 28, 2020
doc/Type/Attribute.pod6
Outdated
| For instance, the names of all the attributes of a type can be introspected | ||
| using its L<name|#method_name> method: | ||
|
|
||
| =begin code :solo |
There was a problem hiding this comment.
Why :solo? This would compile correctly, right? And it does not need its own file.
doc/Type/Attribute.pod6
Outdated
|
|
||
| Because of C<Attribute>, a type containing attributes, such as this: | ||
|
|
||
| =for code :solo |
JJ
requested changes
May 30, 2020
| since Attribute is at the level of the metaclass, all is fair game. | ||
| =head2 method new | ||
|
|
||
| =for code :skip-test<too long a method signature for one line> |
There was a problem hiding this comment.
In principle, there should be no problem with so many lines, as long as you use =for code or =begin code
|
|
||
| Creates a new attribute. The following named arguments are required: | ||
|
|
||
| - C<$name> contains the attribute's name, which should always be a |
|
|
I don't think we need "Declared as:" going forward - having the signature as the first line seems obvious enough. Looks like Mu is the only place this was used. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The problem
Attributeis documented as being something you normally shouldn't use directly. I think this is useful to do when working with the MOP though, and I useAttributelike this in an example in the revision of one of the role HOWs' type pages (#3353).Solution provided
Attribute's type page somewhat and remove some unnnecessary "Defined as:" before each method signature.Attributecan be used when working with the MOP.Attribute.new, along withAttribute.is_bound, andAttribute.is_built.:bindwith theis builttrait, as this is referred to by the new documentation forAttribute.new.