René's URL Explorer Experiment


Title: Documentation Style Guide for contributors by jeromefv · Pull Request #20216 · matplotlib/matplotlib · GitHub

Open Graph Title: Documentation Style Guide for contributors by jeromefv · Pull Request #20216 · matplotlib/matplotlib

X Title: Documentation Style Guide for contributors by jeromefv · Pull Request #20216 · matplotlib/matplotlib

Description: PR Summary Added Documentation Style guide from #19183 Included reference in TOC tree for developers-guide-index .rst file PR Checklist Has pytest style unit tests (and pytest passes). Is Flake 8 compliant (run flake8 on changed files to check). New features are documented, with examples if plot related. Documentation is sphinx and numpydoc compliant (the docs should build without error). Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all). New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there). API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

Open Graph Description: PR Summary Added Documentation Style guide from #19183 Included reference in TOC tree for developers-guide-index .rst file PR Checklist Has pytest style unit tests (and pytest passes). Is Fla...

X Description: PR Summary Added Documentation Style guide from #19183 Included reference in TOC tree for developers-guide-index .rst file PR Checklist Has pytest style unit tests (and pytest passes). Is Fla...

Opengraph URL: https://github.com/matplotlib/matplotlib/pull/20216

X: @github

direct link

Domain: github.com

route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:bd86297e-3732-f82d-b224-a861e93a1b72
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-idA1A4:F01E1:CDABAB:111D48D:6A540A85
html-safe-nonce669c2b368aea0894452977d73aaa2f493129042357ab4ef5b6a02774006b6eef
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBMUE0OkYwMUUxOkNEQUJBQjoxMTFENDhEOjZBNTQwQTg1IiwidmlzaXRvcl9pZCI6IjI1NjMyMTIyNDMyNDEyNzM5ODkiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac836bd0f9370c9b3334452f6dcb94253cdd612da2c4cf9ae6c52677dc07fb9630
hovercard-subject-tagpull_request:643644316
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/matplotlib/matplotlib/pull/20216/files
twitter:imagehttps://avatars.githubusercontent.com/u/18316979?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/18316979?s=400&v=4
og:image:altPR Summary Added Documentation Style guide from #19183 Included reference in TOC tree for developers-guide-index .rst file PR Checklist Has pytest style unit tests (and pytest passes). Is Fla...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
Noneb9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git
octolytics-dimension-user_id215947
octolytics-dimension-user_loginmatplotlib
octolytics-dimension-repository_id1385122
octolytics-dimension-repository_nwomatplotlib/matplotlib
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id1385122
octolytics-dimension-repository_network_root_nwomatplotlib/matplotlib
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release07a982c1d40157c619b364352b704c3ce66bb332
ui-targetcanary-1
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/matplotlib/matplotlib/pull/20216/files#start-of-content
https://github.com/
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmatplotlib%2Fmatplotlib%2Fpull%2F20216%2Ffiles
GitHub CopilotWrite better code with AIhttps://github.com/features/copilot
GitHub Copilot appDirect agents from issue to mergehttps://github.com/features/ai/github-app
MCP RegistryNewIntegrate external toolshttps://github.com/mcp
ActionsAutomate any workflowhttps://github.com/features/actions
CodespacesInstant dev environmentshttps://github.com/features/codespaces
IssuesPlan and track workhttps://github.com/features/issues
Code ReviewManage code changeshttps://github.com/features/code-review
GitHub Advanced SecurityFind and fix vulnerabilitieshttps://github.com/security/advanced-security
Code securitySecure your code as you buildhttps://github.com/security/advanced-security/code-security
Secret protectionStop leaks before they starthttps://github.com/security/advanced-security/secret-protection
Why GitHubhttps://github.com/why-github
Documentationhttps://docs.github.com
Bloghttps://github.blog
Changeloghttps://github.blog/changelog
Marketplacehttps://github.com/marketplace
View all featureshttps://github.com/features
Enterpriseshttps://github.com/enterprise
Small and medium teamshttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
App Modernizationhttps://github.com/solutions/use-case/app-modernization
DevSecOpshttps://github.com/solutions/use-case/devsecops
DevOpshttps://github.com/solutions/use-case/devops
CI/CDhttps://github.com/solutions/use-case/ci-cd
View all use caseshttps://github.com/solutions/use-case
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
View all industrieshttps://github.com/solutions/industry
View all solutionshttps://github.com/solutions
AIhttps://github.com/resources/articles?topic=ai
Software Developmenthttps://github.com/resources/articles?topic=software-development
DevOpshttps://github.com/resources/articles?topic=devops
Securityhttps://github.com/resources/articles?topic=security
View all topicshttps://github.com/resources/articles
Customer storieshttps://github.com/customer-stories
Events & webinarshttps://github.com/resources/events
Ebooks & reportshttps://github.com/resources/whitepapers
Business insightshttps://github.com/solutions/executive-insights
GitHub Skillshttps://skills.github.com
Documentationhttps://docs.github.com
Customer supporthttps://support.github.com
Community forumhttps://github.com/orgs/community/discussions
Trust centerhttps://github.com/trust-center
Partnershttps://github.com/partners
View all resourceshttps://github.com/resources
GitHub SponsorsFund open source developershttps://github.com/open-source/sponsors
Security Labhttps://securitylab.github.com
Maintainer Communityhttps://maintainers.github.com
Acceleratorhttps://github.com/open-source/accelerator
GitHub Starshttps://stars.github.com
Archive Programhttps://archiveprogram.github.com
Topicshttps://github.com/topics
Trendinghttps://github.com/trending
Collectionshttps://github.com/collections
Enterprise platformAI-powered developer platformhttps://github.com/enterprise
GitHub Advanced SecurityEnterprise-grade security featureshttps://github.com/security/advanced-security
Copilot for BusinessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Pricinghttps://github.com/pricing
Search syntax tipshttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
documentationhttps://docs.github.com/search-github/github-code-search/understanding-github-code-search-syntax
Sign in https://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fmatplotlib%2Fmatplotlib%2Fpull%2F20216%2Ffiles
Sign up https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=matplotlib%2Fmatplotlib
Reloadhttps://github.com/matplotlib/matplotlib/pull/20216/files
Reloadhttps://github.com/matplotlib/matplotlib/pull/20216/files
Reloadhttps://github.com/matplotlib/matplotlib/pull/20216/files
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
matplotlib https://github.com/matplotlib
matplotlibhttps://github.com/matplotlib/matplotlib
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
Notifications https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Fork 8.4k https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Star 23k https://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib
Code https://github.com/matplotlib/matplotlib
Issues 1.1k https://github.com/matplotlib/matplotlib/issues
Pull requests 408 https://github.com/matplotlib/matplotlib/pulls
Actions https://github.com/matplotlib/matplotlib/actions
Projects https://github.com/matplotlib/matplotlib/projects
Wiki https://github.com/matplotlib/matplotlib/wiki
Security and quality 0 https://github.com/matplotlib/matplotlib/security
Insights https://github.com/matplotlib/matplotlib/pulse
Code https://github.com/matplotlib/matplotlib
Issues https://github.com/matplotlib/matplotlib/issues
Pull requests https://github.com/matplotlib/matplotlib/pulls
Actions https://github.com/matplotlib/matplotlib/actions
Projects https://github.com/matplotlib/matplotlib/projects
Wiki https://github.com/matplotlib/matplotlib/wiki
Security and quality https://github.com/matplotlib/matplotlib/security
Insights https://github.com/matplotlib/matplotlib/pulse
Sign up for GitHub https://github.com/signup?return_to=%2Fmatplotlib%2Fmatplotlib%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fmatplotlib%2Fmatplotlib%2Fissues%2Fnew%2Fchoose
story645https://github.com/story645
matplotlib:masterhttps://github.com/matplotlib/matplotlib/tree/master
jeromefv:docs_style_guidehttps://github.com/jeromefv/matplotlib/tree/docs_style_guide
Conversation 2 https://github.com/matplotlib/matplotlib/pull/20216
Commits 2 https://github.com/matplotlib/matplotlib/pull/20216/commits
Checks 0 https://github.com/matplotlib/matplotlib/pull/20216/checks
Files changed https://github.com/matplotlib/matplotlib/pull/20216/files
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
Documentation Style Guide for contributors https://github.com/matplotlib/matplotlib/pull/20216/files#top
Show all changes 2 commits https://github.com/matplotlib/matplotlib/pull/20216/files
7ccb7a8 Added style_guide.rst from PR#19183 jeromefv May 13, 2021 https://github.com/matplotlib/matplotlib/pull/20216/commits/7ccb7a8e121bddc9b58545ee5ec87342bf7f8d83
3abedd9 Added style_guide.rst to dev guide index TOC tree jeromefv May 13, 2021 https://github.com/matplotlib/matplotlib/pull/20216/commits/3abedd9ca60d748738c00b399490d5afa566d347
Clear filters https://github.com/matplotlib/matplotlib/pull/20216/files
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
index.rst https://github.com/matplotlib/matplotlib/pull/20216/files#diff-a09d4abbcf2f9cf30330d80e40b76b11f2c283310399c535b755d257912e7398
style_guide.rst https://github.com/matplotlib/matplotlib/pull/20216/files#diff-f836d05bbab3a189c7e8255ab9618e0aa60b93227dcbbc615ce58fa3f6c6bef8
doc/devel/index.rsthttps://github.com/matplotlib/matplotlib/pull/20216/files#diff-a09d4abbcf2f9cf30330d80e40b76b11f2c283310399c535b755d257912e7398
View file https://github.com/jeromefv/matplotlib/blob/3abedd9ca60d748738c00b399490d5afa566d347/doc/devel/index.rst
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/matplotlib/matplotlib/pull/20216/{{ revealButtonHref }}
https://github.com/matplotlib/matplotlib/pull/20216/files#diff-a09d4abbcf2f9cf30330d80e40b76b11f2c283310399c535b755d257912e7398
https://github.com/matplotlib/matplotlib/pull/20216/files#diff-a09d4abbcf2f9cf30330d80e40b76b11f2c283310399c535b755d257912e7398
Please reload this pagehttps://github.com/matplotlib/matplotlib/pull/20216/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.