GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Docfix/improve description by WeatherGod · Pull Request #45 · matplotlib/matplotlib

Conversation

@WeatherGod

@WeatherGod WeatherGod commented Mar 14, 2011

Copy link
Copy Markdown
Member

My work so far to improve the documentation in various places. This is far from complete and I hope someone else can contribute more improvements.

Of particular focus were grammatical and spelling errors, descriptions of how to use matplotlib (including differences between pylab and pyplot), expanded discussion of the show() command, and improvements to the docs for mplot3d.

I have also worked to eliminate some of the sphinx warning messages, but I have not addressed any of the plot directive errors.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
WeatherGod added 11 commits March 14, 2011 14:51
@WeatherGod
Hopefully improving the wording in usage_faq.rst to make clear the di…
5b5b3c9 
…fferences between pyplot and pylab.
@WeatherGod
Significant revision to the usage_faq documentation. Hopefully, this …
f191ae5 
…will clarify the matplotlib design better.
@WeatherGod
Minor polishing work, fixing typos and grammar in the faq.
fdc7c89
@WeatherGod
Incorporate comments from Eric Firing regarding usage of pyplot versu…
cee750e 
…s pylab.
@WeatherGod
Apparently, I can't spell... fixing my mistakes and others in the faqs.
30dc21a
@WeatherGod
Improve docs for mplot3d.
7b57b27
@WeatherGod
Update sphinx docs to use c-domains.
79d7022
@WeatherGod
Fixed malformed hyperlink target warning in image_tutorial.rst
a3319c6
@WeatherGod
Fixed unescaped vertical line in recipes.rst.
9399b2d
@WeatherGod
Further revisions to the mplot3d docs to include when certain feature…
6a16eea 
…s were added, a table of contents, and improved the aspect ration of the subplot figures.
@WeatherGod
Added significant information regarding the usage of the show() command.
339705c
efiring
efiring reviewed Mar 14, 2011
View reviewed changes
Comment thread doc/faq/usage_faq.rst Outdated

@efiring efiring Mar 14, 2011

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ben, I think this whole general concepts block is confusing and misleading. A much shorter version might work. Maybe on the idea of hierarchy:

Plotting requires action on a range of levels, from the most general at the top (e.g., "contour this 2-D array") to the most specific at the bottom: (e.g., "color this screen pixel red"). The purpose of a plotting package is to assist the user in visualizing data as easily as possible, with all necessary control--that is, by using relatively high-level commands most of the time, but with the ability to access lower levels. In matplotlib, the highest level of the plotting hierarchy is provided via the state-machine environment of the matplotlib.pyplot module. As in MATLAB, simple functions are used to add plot elements (lines, images, text) to the current axes in the current figure. [maybe put your s-m example here] The next level down in the hierarchy is the first level of the object-oriented interface, in which pyplot is used only for a few functions such as figure creation, and the user explicitly keeps track of figures and axes. [maybe your previous example, but without the gca.] For even more control--which is essential for things like embedding matplotlib plotting in GUI applications--the pyplot level may be dropped completely, leaving a purely object-oriented approach.

Something like this might be enough to lead in to the next section; omitting the examples above might then be best, since the next section has examples.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@WeatherGod

WeatherGod commented Mar 14, 2011

Copy link
Copy Markdown
Member Author

I think my "General Concepts" block started off as one thing, but became an explanation of "state-machine environment" which pops up later. I think we could definitely eliminate the second paragraph in "General Concepts". Then, I should fully explain the hierarchy (I want to mesh my explanation with yours), and defer the explanation of the state-machine to last.

I also feel that the examples are really important to directly illustrate what the state-machine environment is. While it is incredibly obvious to you and me, to others, a "state-machine environment" might be a very unintuitive phrase that needs a clean example. Note that my examples are demonstrating something slightly different than the examples later on. Mine uses pyplot, and focuses on implicit/explicit creation of objects while the later examples show the difference between pyplot and pylab.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@ddale

ddale commented Mar 14, 2011

Copy link
Copy Markdown
Contributor

There is really no difference between pyplot and pylab though, right? Pyplot still provides the same "state-machine" interface, but without all the numpy imports that pylab provides.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@efiring

efiring commented Mar 14, 2011

Copy link
Copy Markdown
Member

On 03/14/2011 12:04 PM, darrendale wrote:

There is really no difference between pyplot and pylab though, right? Pyplot still provides the same "state-machine" interface, but without all the numpy imports that pylab provides.

Correct, as explained in the original FAQ.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@WeatherGod

WeatherGod commented Mar 15, 2011

Copy link
Copy Markdown
Member Author

There is really no difference between pyplot and pylab though, right? Pyplot still provides the same "state-machine" interface, but without all the numpy imports that pylab provides.

Correct, as explained in the original FAQ.

I don't see how that changed in usage_faq.rst. I could make it more explicit, but I think it would only serve to confuse the reader further because they will wonder what's the point of having the two interfaces.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@WeatherGod
Changes to usage_faq.rst taking into account comments from Eric.
112a1b8
@WeatherGod

WeatherGod commented Mar 15, 2011

Copy link
Copy Markdown
Member Author

Let me know if this is better.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@efiring

efiring commented Mar 15, 2011

Copy link
Copy Markdown
Member

On 03/15/2011 05:15 AM, WeatherGod wrote:

Let me know if this is better.

Yes, I think that is clearer. Thank you.

Eric
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
ddale
ddale reviewed Mar 19, 2011
View reviewed changes
Comment thread doc/faq/installing_faq.rst Outdated

@ddale ddale Mar 19, 2011

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That should be "build-dep", not "build_dep"

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@WeatherGod WeatherGod Mar 19, 2011

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed. Thanks for catching that.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@WeatherGod
Fixing an incorrect apt-get command in installing_faq.rst.
f230d7a
@WeatherGod

WeatherGod commented Mar 25, 2011

Copy link
Copy Markdown
Member Author

If there are no more comments on these docs, shall I assume it is good to merge?
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@efiring

efiring commented Mar 25, 2011

Copy link
Copy Markdown
Member

On 03/25/2011 03:57 AM, WeatherGod wrote:

If there are no more comments on these docs, shall I assume it is good to merge?

Fine with me.

Eric
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@WeatherGod
WeatherGod merged commit f230d7a into matplotlib:v1.0.x Mar 28, 2011
@richbwood richbwood mentioned this pull request Dec 19, 2012
test_pcolormesh hangs #1609
Closed
magnunor pushed a commit to magnunor/matplotlib that referenced this pull request Dec 5, 2013
@francisco-dlp
Fixes matplotlib#45 and adds new models package and eelsmodel (atm em…
1a3b380 
…pty) model
@WeatherGod
WeatherGod deleted the docfix/improve_description branch July 23, 2014 12:55
fariza added a commit to fariza/matplotlib that referenced this pull request Sep 22, 2016
@fariza
Merge pull request matplotlib#45 from fariza/plot-tweaking
1eec217 
modifying styles for latest template
@WeatherGod WeatherGod mentioned this pull request Mar 2, 2018
pyplot hangs at plot() #10648
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@WeatherGod @ddale @efiring
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.