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

Fixed the issue of pyplot tutorial missing the show() command #2344

Merged
merged 5 commits into from
Aug 26, 2013

Conversation

anshbansal
Copy link
Contributor

Fixed this issue #2337

@mdboom
Copy link
Member

mdboom commented Aug 26, 2013

I wonder whether we should make this chance, or instead introduce interactive mode here, which wouldn't require the use of show at all (at least when working from an interactive console). I think that's the assumption that many of these examples are under.

@anshbansal
Copy link
Contributor Author

Introducing interactive mode at the beginning may not be the best idea. Placing a comment that the show() command isn't needed in interactive mode may be a better option. If you really want to do that then you should probably take out the show() from the 2 examples which already have it. It is inconsistent and confusing otherwise.

Anyways its your library. Just saying that having an inconsistent documentation(read incorrect for new users) isn't good for getting new users. And this mistake is in the first page about using the library.

@mdboom
Copy link
Member

mdboom commented Aug 26, 2013

Ok -- I don't feel strongly either way. @WeatherGod, @efiring: thoughts?

@WeatherGod
Copy link
Member

The issue we have here is that the two particular examples in question are/could be in use elsewhere. Yes, having mixed styles is bad, but we can't just eliminate the show() call as it might be used elsewhere in a non interactive context. Because we have largely solved the show() problems that have plagued us from v1.0 and earlier, I vote for a more liberal use of show(). It would work regardless of the code being used in an interactive mode or not, so users are less likely to be confused when the copied and pasted code doesn't work in their scripts.

@mdboom
Copy link
Member

mdboom commented Aug 26, 2013

Ok, then. I'm going to merge and backport to v1.3.x.

mdboom added a commit that referenced this pull request Aug 26, 2013
Fixed the issue of pyplot tutorial missing the show() command
@mdboom mdboom merged commit 8985b1b into matplotlib:master Aug 26, 2013
mdboom added a commit that referenced this pull request Aug 26, 2013
Fixed the issue of pyplot tutorial missing the show() command
@anshbansal
Copy link
Contributor Author

How often is the online documentation built? It isn't updated yet.

@mdboom
Copy link
Member

mdboom commented Aug 30, 2013

It's normally only update with each release, but it's probably worth doing an update now in any event.

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.

3 participants