Skip to content

Fix missing references in doc build. #15134

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 1 commit into from
Aug 26, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Aug 26, 2019

PR Summary

the usual dance

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

@ImportanceOfBeingErnest
Copy link
Member

ImportanceOfBeingErnest commented Aug 26, 2019

What's wrong with that reference? Why does it not point to the AttributeCopier as it should?

(I'm more interested in why it fails, not so much in making sure this utterly important class gets a link it surely deserves. ;-))

@anntzer
Copy link
Contributor Author

anntzer commented Aug 26, 2019

Because many things in mpl_toolkits have no API entry. Certainly that should probably be fixed; OTOH AttributeCopier is clearly an implementation detail and is not very high in the priority list.

@ImportanceOfBeingErnest ImportanceOfBeingErnest added this to the v3.2.0 milestone Aug 26, 2019
@ImportanceOfBeingErnest
Copy link
Member

Merging this directly because it fixes the doc builts.

If you can maybe extend #15042 (comment) to include what exactly needs to be done for something to aquire "an API entry", that'd be very helpful.

@ImportanceOfBeingErnest ImportanceOfBeingErnest merged commit 46186b9 into matplotlib:master Aug 26, 2019
@tacaswell
Copy link
Member

Thanks @anntzer and @ImportanceOfBeingErnest !

@anntzer anntzer deleted the badrefs branch August 27, 2019 09:00
@anntzer anntzer mentioned this pull request Aug 27, 2019
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants