Navigation Menu

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

Allow :context: directive to take 'reset' option. Fixes #2892. #2913

Merged
merged 2 commits into from Apr 17, 2014

Conversation

astrofrog
Copy link
Contributor

This allows:

:context: reset

and resets the plotting context. This is crucial when if one wants to use :context: for multiple figures in documentation. See #2892.

One question - should:

:context: True

and

:context: False

work? If so, I'll need to slightly adjust _option_context.

cc @mdboom

@astrofrog
Copy link
Contributor Author

@mdboom - is a CHANGELOG entry needed?

@mdboom
Copy link
Member

mdboom commented Mar 21, 2014

As a new feature, I would mention this briefly in whatsnew.

@tacaswell
Copy link
Member

Yes, and definitely api_changes.rst and maybe a whats_new.rst

@astrofrog
Copy link
Contributor Author

@mdboom @tacaswell - Does this go in the New plotting features section in what's new? Since this doesn't break the current API, is an entry in api_changes.rst needed anyway?

Also, is :context: True valid or do I not need to worry about this?

@mdboom
Copy link
Member

mdboom commented Mar 21, 2014

I don't think we need an api changes entry -- that's really only for backward-incompatible things.

I would put it in a new section in what's new called "Sphinx extensions" (which we don't normally have, because it doesn't change much).

I don't think context True and False need to work. The old docs saying "bool" essentially means "present or not".

@astrofrog
Copy link
Contributor Author

@mdboom - done - is this ok?

@tacaswell
Copy link
Member

@mdboom interesting. I apparently miss-understood that.

@astrofrog
Copy link
Contributor Author

@mdboom @tacaswell - the Travis error is unrelated.

@tacaswell tacaswell added this to the v1.4.0 milestone Mar 24, 2014
@astrofrog
Copy link
Contributor Author

@mdboom @tacaswell - does this look good to go?

@tacaswell
Copy link
Member

@astrofrog This needs a rebase. I suspect from conflicts from your other PR

@astrofrog
Copy link
Contributor Author

@tacaswell - thanks for letting me know - I've now rebased this

tacaswell added a commit that referenced this pull request Apr 17, 2014
Allow :context: directive to take 'reset' option. Fixes #2892.
@tacaswell tacaswell merged commit a429c41 into matplotlib:master Apr 17, 2014
@astrofrog
Copy link
Contributor Author

@tacaswell - thanks for merging this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants