Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Reformatted documentation under project directory #26958

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
Closed
wants to merge 1 commit into from
Closed

Reformatted documentation under project directory #26958

wants to merge 1 commit into from

Conversation

iamfaham
Copy link
Contributor

@iamfaham iamfaham commented Sep 29, 2023 •
edited
Loading

PR summary

I have reformatted the documentation under the ./doc/users/project directory according to the formatting and style conventions available at (https://matplotlib.org/devdocs/devel/document.html#section-formatting)[https://matplotlib.org/devdocs/devel/document.html#section-formatting] . This PR addresses the issue #26862

PR checklist

github-actions[bot]
github-actions bot reviewed Sep 29, 2023
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@story645
Copy link
Member

Thanks for taking this on but I'm really sorry - in my issue I should have mentioned that files under project are the one thing that shouldn't be touched w/ respect to title casing.

@iamfaham
Copy link
Contributor Author

No problem, I'll check through if there are any other issues i can resolve.

@iamfaham iamfaham closed this Sep 29, 2023
@story645
Copy link
Member

No problem, I'll check through if there are any other issues i can resolve.

So a hack for this is to search for ~~~ as that's usually in the files with the old standard. Ignore files in whats new and api changes though

@iamfaham
Copy link
Contributor Author

No problem, I'll check through if there are any other issues i can resolve.

So a hack for this is to search for ~~~ as that's usually in the files with the old standard. Ignore files in whats new and api
changes though

That was helpful, thanks for the hack.

@iamfaham
Copy link
Contributor Author

iamfaham commented Oct 3, 2023

Screenshot 2023-10-03 200624
Hey @story645 , I just wanted to ask if this is one of the file to be worked upon. I was just a bit confused so please clarify this.

@story645
Copy link
Member

story645 commented Oct 3, 2023

Yes that file has the old style formatting, but the ------ heading level looks correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Doc]: regularize doc formatting
2 participants
@iamfaham @story645