Skip to content

Document ArtistList#22177

Merged
tacaswell merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-axeslist
Jan 12, 2022
Merged

Document ArtistList#22177
tacaswell merged 1 commit into
matplotlib:mainfrom
timhoffm:doc-axeslist

Conversation

@timhoffm

@timhoffm timhoffm commented Jan 9, 2022

Copy link
Copy Markdown
Member

PR Summary

Closes #22094.

While ArtistList will vanish again in 3.7. Users can encounter it and thus should know what it is and how it is supposed to be used.

@timhoffm timhoffm added this to the v3.5.2 milestone Jan 9, 2022
@QuLogic

QuLogic commented Jan 11, 2022

Copy link
Copy Markdown
Member

Hmm, I'm not sure we can document the nested class, as that seems to be what trips Sphinx up:

WARNING: autodoc: failed to import class 'ArtistList' from module 'Axes'; the following exception was raised:
No module named 'Axes'

@timhoffm

timhoffm commented Jan 11, 2022

Copy link
Copy Markdown
Member Author

Ok, I have replaced the autosummary entry with a separate autoclass call, which can handle inner classes. This is not quite is nice because it dums the whole class docs instead of a summary with a link. But ArtistList is only a temporary helper structure, which will vanish again in 3.7. So it's not worth fiddling too much with sphinx. The main point that the user can find it and read what it is is fulfilled.

@QuLogic

QuLogic commented Jan 11, 2022

Copy link
Copy Markdown
Member

You'll need to rebase to get #22190 for docs to build.

@tacaswell tacaswell merged commit 806f00a into matplotlib:main Jan 12, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Jan 12, 2022
@timhoffm timhoffm deleted the doc-axeslist branch January 12, 2022 18:17
timhoffm added a commit that referenced this pull request Jan 12, 2022
…177-on-v3.5.x

Backport PR #22177 on branch v3.5.x (Document ArtistList)
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
imgbot Bot pushed a commit to kkipngenokoech/matplotlib that referenced this pull request Apr 19, 2026
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.

[Doc]: No documentation on ArtistList

3 participants