Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docfixes 1.1.x #500

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

Merged
merged 3 commits into from
Oct 2, 2011
Merged

Docfixes 1.1.x #500

merged 3 commits into from
Oct 2, 2011

Conversation

jdh2358
Copy link
Collaborator

@jdh2358 jdh2358 commented Sep 29, 2011

Trying to get rid of as many doc warnings as possible

  • Remove matplotlib.legend from artist_api.rst since it is document in legend_api
  • Fix pyplot docstring :module: -> :mod to remove error: Unknown interpreted text role "module".
  • Fix pyplot tight_layout docstring to get rid of 'Unexpected section title.' error
  • reformatted docstring in tight_layout.auto_adjust_subplotpars
  • fix what's new bullet list ends w/o blank line issues
  • remove plotting.rst and arraydata.rst stub docs
  • Added environment_variables.rst to FAQ index
  • removed normed warning on Axes.hist
  • fix an nxutils.point_inside_poly docstring definition list bug
  • added double pendulum example for animation with link from what's new

…n legend_api

* Fix pyplot docstring :module: -> :mod to remove error: Unknown interpreted text role "module".

* Fix pyplot tight_layout docstring to get rid of 'Unexpected section title.' error

* reformatted docstring in tight_layout.auto_adjust_subplotpars

* fix what's new bullet list ends w/o blank line issues

* remove plotting.rst and arraydata.rst stub docs

* Added environment_variables.rst to FAQ index

* removed normed warning on Axes.hist

* fix an nxutils.point_inside_poly docstring definition list bug
@WeatherGod
Copy link
Member

I totally forgot about that double-pendulum example! It is too bad we haven't yet figure out how to build and embed animation examples into the docs...

@WeatherGod
Copy link
Member

Anyway, most of these fixes were ones I was itching to do anyway. Good job catching most of those warnings. I don't see any immediate reason not to merge this in now.

@jdh2358
Copy link
Collaborator Author

jdh2358 commented Oct 2, 2011

We could create an mpl acct for YouTube, upload an mpl movie, and embed it.

On Oct 1, 2011, at 9:04 PM, Benjamin [email protected] wrote:

I totally forgot about that double-pendulum example! It is too bad we haven't yet figure out how to build and embed animation examples into the docs...

Reply to this email directly or view it on GitHub:
#500 (comment)

@jdh2358
Copy link
Collaborator Author

jdh2358 commented Oct 2, 2011

There are a few lingering "index.rst" not in any TOC but I am not sure what to do with them. Would be nice to get down to zero warnings. I think I'm going to leave the request open until tomorrow to get any last minute fixes in. Thanks for taking a lol.

On Oct 1, 2011, at 9:05 PM, Benjamin [email protected] wrote:

Anyway, most of these fixes were ones I was itching to do anyway. Good job catching most of those warnings. I don't see any immediate reason not to merge this in now.

Reply to this email directly or view it on GitHub:
#500 (comment)

@jdh2358
Copy link
Collaborator Author

jdh2358 commented Oct 2, 2011

OK, added the youtube video to what's new (nice suggestion)

jdh2358 added a commit that referenced this pull request Oct 2, 2011
@jdh2358 jdh2358 merged commit da25c48 into matplotlib:v1.1.x Oct 2, 2011
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.

2 participants