Add additional callbacks for functions with default params #319
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
In pretty much every public function in `ex_machina` you allow users to either give or not give parameters for the resource that's being built, but in the documentation that's not shown because you can't show optional arguments in callback definitions. This commit adds callbacks for these `/1` or `/2` functions that are commonly used. This benefits documentation, but also enforces the behaviour contract to make sure that all documented functionality is implemented correctly.
|
Nice catch with this. Thanks for adding these @devonestes! |
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 pretty much every public function in
ex_machinayou allow users toeither give or not give parameters for the resource that's being built,
but in the documentation that's not shown because you can't show
optional arguments in callback definitions.
This commit adds callbacks for these
/1or/2functions that arecommonly used. This benefits documentation, but also enforces the
behaviour contract to make sure that all documented functionality is
implemented correctly.
I also formatted the files that I touched (because that's just what my
editor does when I save a file 😉).