8000 Merge doc/api/api_overview and doc/api/index. by anntzer · Pull Request #14176 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Merge doc/api/api_overview and doc/api/index. #14176

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 11, 2019
Merged

Merge doc/api/api_overview and doc/api/index. #14176

merged 2 commits into from
May 11, 2019

Conversation

anntzer
Copy link
Contributor
@anntzer anntzer commented May 9, 2019

PR Summary

... as discussed in #13796 and #13808.

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@dstansby
Copy link
Member
dstansby commented May 9, 2019

https://7097-7439715-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/index.html for anyone else that wants to see the docs with this change.

dstansby
dstansby approved these changes May 9, 2019
View reviewed changes
Copy link
Member
@dstansby dstansby left a comment

Choose a reason for hiding this comment

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

👍 I think this is a nice improvement, and would close #13796

@dstansby dstansby mentioned this pull request May 9, 2019
Closed
@timhoffm
Copy link
Member
timhoffm commented May 9, 2019

👍 for working on this. However, I feel that putting modules and toolkits into the object oriented section is the wrong level. What about:

  • API Overview
    • Usage patterns
      • The pyplot API
      • The object-oriented API
      • The pylab API (disapproved)
    • Modules
    • Toolkits

@anntzer
Copy link
Contributor Author
anntzer commented May 9, 2019 •
edited
Loading

Sure, that's fine with me too... but you get to push that :)

@tacaswell tacaswell modified the milestones: v3.2.0, v3.1.0 May 11, 2019
@tacaswell tacaswell merged commit 91af1f4 into matplotlib:master May 11, 2019
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request May 11, 2019
@tacaswell
Backport PR matplotlib#14176: Merge doc/api/api_overview and doc/api/…
2573f37 
…index.
@meeseeksmachine meeseeksmachine mentioned this pull request May 11, 2019
Merged
@anntzer anntzer deleted the api branch May 11, 2019 22:07
tacaswell added a commit that referenced this pull request May 11, 2019
@tacaswell
Merge pull request #14190 from meeseeksmachine/auto-backport-of-pr-14…
64e567e 
…176-on-v3.1.x

Backport PR #14176 on branch v3.1.x (Merge doc/api/api_overview and doc/api/index.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dstansby dstansby dstansby approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.1.0
Development

Successfully merging this pull request may close these issues.
4 participants
@anntzer @dstansby @timhoffm @tacaswell
0