Mojolicious::Guides: explain the convention of method examples that return the invocant #2237
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
…eturn the invocant
kraih
requested review from
a team,
marcusramberg,
kraih,
jhthorsen and
jberger
kraih
approved these changes
Mar 11, 2025
|
Already merged but 👍 from me as well |
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.
Summary
Add a bit of documentation to the main guides CONVENTIONS section explaining the common example of a method that returns its invocant for chaining.
Motivation
This construct is used a lot in doc examples, but doesn't represent how the method should actually be called and its intent may not be obvious.
References