Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Document ArtistList#22177

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
tacaswell merged 1 commit intomatplotlib:mainfromtimhoffm:doc-axeslist
Jan 12, 2022
Merged

Conversation

timhoffm
Copy link
Member

PR Summary

Closes#22094.

WhileArtistList 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.

@timhoffmtimhoffm added this to thev3.5.2 milestoneJan 9, 2022
@QuLogic
Copy link
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
Copy link
MemberAuthor

timhoffm commentedJan 11, 2022
edited
Loading

Ok, I have replaced theautosummary entry with a separateautoclass 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. ButArtistList 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
Copy link
Member

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

timhoffm reacted with thumbs up emoji

@tacaswelltacaswell merged commit806f00a intomatplotlib:mainJan 12, 2022
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull requestJan 12, 2022
@timhoffmtimhoffm deleted the doc-axeslist branchJanuary 12, 2022 18:17
timhoffm added a commit that referenced this pull requestJan 12, 2022
…177-on-v3.5.xBackport PR#22177 on branch v3.5.x (Document ArtistList)
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@QuLogicQuLogicQuLogic approved these changes

Assignees
No one assigned
Projects
None yet
Milestone
v3.5.2
Development

Successfully merging this pull request may close these issues.

[Doc]: No documentation on ArtistList
3 participants
@timhoffm@QuLogic@tacaswell

[8]ページ先頭

©2009-2025 Movatter.jp