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

Doc cleanup #3133

Merged
merged 10 commits into from Jun 12, 2014
Merged

Doc cleanup #3133

merged 10 commits into from Jun 12, 2014

Conversation

tacaswell
Copy link
Member

Probably not ready to merge.

I would like feed back on most of this.

I assume there was a reason for only putting the
examples in the html docs, but I don't see it.
Removed example of how parse output from svn logs.
Parameter -> Parameters

Example -> Examples
Added section on high-level plotting with seaborn and ggplot.

Added mpldatacursor and prettyplotlib.
@tacaswell tacaswell added this to the v1.4.0 milestone Jun 10, 2014
@tacaswell
Copy link
Member Author

@olgabot @joferkington @mwaskom @glamp I added references to all of your projects to the mpl docs. Please verify I did not put my foot in my mouth.

Several projects have started to provide a higher-level interface to
matplotlib. These are independent projects.

Seborn
Copy link

Choose a reason for hiding this comment

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

Missing an "a". Also not a huge deal but I usually don't capitalize the "s".

Copy link
Member Author

Choose a reason for hiding this comment

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

Gah!, sorry about that...

@mwaskom
Copy link

mwaskom commented Jun 11, 2014

Thanks for adding this! Since much of my two sentence intro is redundant in the context of the matplotlib documentation, I'd suggest something like

  • seaborn is a high level interface for drawing statistical graphics with matplotlib. It aims to make visualization a central part of exploring and understanding complex datasets.

@olgabot
Copy link
Contributor

olgabot commented Jun 11, 2014

Looks great, thanks!


Olga Botvinnik
PhD Program in Bioinformatics and Systems Biology
Gene Yeo Laboratory http://yeolab.ucsd.edu/yeolab/Home.html | Sanford
Consortium for Regenerative Medicine
University of California, San Diego
www http://olgabotvinnik.com | blog http://blog.olgabotvinnik.com/ |
github http://github.com/olgabot | twitter http://twitter.com/olgabot |
linkedin http://www.linkedin.com/in/olgabotvinnik

2014-06-10 17:29 GMT-07:00 Michael Waskom notifications@github.com:

Thanks for adding this! Since much of my two sentence intro is redundant
in the context of the matplotlib documentation, I'd suggest something like

  • seaborn is a high level interface for drawing statistical graphics
    with matplotlib. It aims to make visualization a central part of exploring
    and understanding complex datasets.


Reply to this email directly or view it on GitHub
#3133 (comment)
.

 - use blurb suggest by @mwaskom
 - added links
@@ -9,6 +9,6 @@ backends
backend_qt4agg_api.rst
backend_wxagg_api.rst
backend_pdf_api.rst
backend_webagg.rst
.. backend_webagg.rst
Copy link
Member

Choose a reason for hiding this comment

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

Why comment it out?

Copy link
Member Author

Choose a reason for hiding this comment

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

Because sphinx errors told me the file does not exist
On Jun 12, 2014 6:58 AM, "Phil Elson" notifications@github.com wrote:

In doc/api/index_backend_api.rst:

@@ -9,6 +9,6 @@ backends
backend_qt4agg_api.rst
backend_wxagg_api.rst
backend_pdf_api.rst

  • backend_webagg.rst
    +.. backend_webagg.rst

Why comment it out?


Reply to this email directly or view it on GitHub
https://github.com/matplotlib/matplotlib/pull/3133/files#r13699574.

@joferkington
Copy link
Contributor

@tacaswell - Thanks for adding this! The blurb on mpldatacursor looks great to me.

pelson added a commit that referenced this pull request Jun 12, 2014
General documentation cleanup and reference to spin-off projects.
@pelson pelson merged commit f1689bb into matplotlib:master Jun 12, 2014
@tacaswell tacaswell deleted the doc_cleanup branch June 25, 2014 17:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Release critical For bugs that make the library unusable (segfaults, incorrect plots, etc) and major regressions.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants