Fix custom type docs on "Intermediate usage" and docstring #434
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
- Returning the same string instead of True draws a clearer picture of the expected behaviour of a custom type function. - Replace 'ValidationError' with a built-in exception.
…just any exception will do
|
Good catch, thanks! |
joshfriend
added a commit
that referenced
this pull request
May 3, 2015
Fix custom type docs on "Intermediate usage" and docstring
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.
Both the
intermediate usageexample on custom types and the related docstrings in theArgumentclass are quite confussing for newcomers:Truedraws a clearer picture of the expected behaviour one custom type.emailexample function and theArgumentdocstring reference aValidationErrorexception which is not present on source and is actually not required (any raised exception will do for converting/validating types).