fix(help): finish #381 for RsT to print enum-choices - #438
Merged
Conversation
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods. + Added TCs for `info()`.
minrk
reviewed
Aug 14, 2017
| choices = repr(list(choices)) | ||
| return choices | ||
|
|
||
| def info(self, as_rst=False): |
Member
There was a problem hiding this comment.
Adding an as_rst arg is a backward-incompatible change because user traits can have defined .info() accepting no arguments, which must not result in any errors.
Maybe better to define a new .info_rst() method that calls .info() by default.
This file contains hidden or 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.
#381 inserted a new line
Choices: x, y, zinto the help and config messages for all Enum traits, immediately aboveDefault: ...line.As had been mentioned in that PR, that feature was never added to the RsT documentation produced by
Configurable.class_config_rst_doc()classs method.This PR fixes that neglect.
as_rst=falsekwd to allXxxEnum.info()methods.info().RsT samples for
info()method:Enum&UseEnumtraits:CaselessStrEnum:FuzzyEnum: