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

Docs: fix grid formatting and add comments to users/index.rst#30641

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

Open
Ajay16code wants to merge2 commits intomatplotlib:main
base:main
Choose a base branch
Loading
fromAjay16code:docs-fix-index

Conversation

Ajay16code
Copy link

I give the two Installation Guide (doc/install/index.rst)
Added Windows-specific virtual environment activation command
Clarified TkAgg backend dependencies
Improved formatting for better readability
Users Guide Index (doc/users/index.rst)
Fixed grid and toctree structure
Added clear section comments
Verified all explain/ links are valid

All documentation builds successfully with make html

@github-actionsgithub-actionsbot added the Documentation: user guidefiles in galleries/users_explain or doc/users labelOct 7, 2025
@rcomer
Copy link
Member

rcomer commentedOct 7, 2025
edited
Loading

Without this change the top level user guide looks like
https://matplotlib.org/devdocs/users/index.html

With this change, it looks like
https://output.circle-artifacts.com/output/job/a7854d82-c33a-405c-b7f4-4469261c29b7/artifacts/0/doc/build/html/users/index.html

All the content is gone, which is clearly not right.

@Ajay16code is there a specific problem you are trying to solve?

@rcomerrcomer added the status: needs clarificationIssues that need more information to resolve. labelOct 7, 2025
@story645
Copy link
Member

story645 commentedOct 9, 2025
edited
Loading

All the content is gone, which is clearly not right.

That's b/c the comments in the PR are denoted using Python syntax but need to be in rst syntax b/c the file is rst.

Looking through the changes in the install guide,@Ajay16code I don't see any of the changes you're saying you've made. I just see small rewordings.

@timhoffm
Copy link
Member

There are two changes here:

  1. Slight rewording of the installation instructions
  2. Change to the user guide grid layout.

(2) is broken and I don't see why we need a change here at all

I'd be willing to accept (1) as the wording is indeed slightly better. It is a tad more precise and less slang. Though, I do not generally encourage word-smithing on every little detail, we may take it now that it's there.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation: user guidefiles in galleries/users_explain or doc/usersstatus: needs clarificationIssues that need more information to resolve.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

4 participants
@Ajay16code@rcomer@story645@timhoffm

[8]ページ先頭

©2009-2025 Movatter.jp