Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(cfg): write also enum choices when generating config.py files #381

Merged
merged 3 commits into from Mar 24, 2017

Conversation

ankostis
Copy link
Contributor

When generating the config.py file, explain the available enum-choices in the comment-lines, like help-message does.

@ankostis
Copy link
Contributor Author

I would like to add one commit more that appends the "Default=" line to the comments above each config-parameter, and totally replicate the help-message.

Currently the default-value is printed in the Class.trait =def_value line.
But if you un-comment and edit that line, you don't know what was the default.

Should I do that?

@minrk
Copy link
Member

minrk commented Mar 21, 2017

sure, that seems ok.

@ankostis
Copy link
Contributor Author

With latest 2 commits now default-value are also printed on comments, and this PR is finished on my part.

An additional change(169e849) is that the enum-choices are printed before the default-value.
Enhanced TCs to check this ordering.

@minrk minrk added this to the 5.0 milestone Mar 24, 2017
@minrk minrk merged commit c622c8e into ipython:master Mar 24, 2017
@ankostis
Copy link
Contributor Author

My apologies, just seen that there is a minor glitch in the generated configuration file (described in the review).

@ankostis ankostis deleted the write_enum_choices branch March 24, 2017 15:52
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 11, 2017
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add an optional `as_rst=false` kwd in all`XxxEnum.info()`
methods.
+ Added TCs for `info().
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods.
+ Added TCs for `info()`.
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods.
+ Added TCs for `info()`.
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods.
+ Added TCs for `info()`.
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods.
+ Added TCs for `info()`.
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 12, 2017
+ Had to add `as_rst=false` kwd to all `XxxEnum.info()` methods.
+ Added TCs for `info()`.
ankostis added a commit to ankostis/traitlets that referenced this pull request Aug 14, 2017
minrk added a commit that referenced this pull request Aug 15, 2017
fix(help): finish #381 for RsT to print enum-choices
@Carreau Carreau added 5.0-re-review Need to re-review for potential API impact changes. 5.0-no-incidence change that has noincidence on 5.0 compat (eg: doc) and removed 5.0-re-review Need to re-review for potential API impact changes. labels Jun 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0-no-incidence change that has noincidence on 5.0 compat (eg: doc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants