"attribute required" documentation improvements #187
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
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.
In trying to figure out some of the specifics of "required" i ended up struggling a bit with the documentations, and after talking with @haarg about it on IRC ended up with two suggestions for improvements.
First off the sentence about default+builder+init_arg was not structured in an obvious way as to what the intent of it was. The rewriting explains the intent first and then how to address the issue.
Additionally the sentence also mentions init_arg which is inherited from Class::MOP::Attribute and otherwise not mentioned in the document at all, making it a bit of a big question mark. Manually mentioning the important inherited options would help that. @haarg also suggested that this could be applied broadly to the moose docs.