Title: [doc]: add 'validate' section to install docs · Issue #26379 · matplotlib/matplotlib · GitHub
Open Graph Title: [doc]: add 'validate' section to install docs · Issue #26379 · matplotlib/matplotlib
X Title: [doc]: add 'validate' section to install docs · Issue #26379 · matplotlib/matplotlib
Description: Documentation Link https://matplotlib.org/devdocs/devel/development_setup.html Problem The install docs don't have instructions on how to check that the install went through correctly. I think, especially for new contributors, it'd be he...
Open Graph Description: Documentation Link https://matplotlib.org/devdocs/devel/development_setup.html Problem The install docs don't have instructions on how to check that the install went through correctly. I think, esp...
X Description: Documentation Link https://matplotlib.org/devdocs/devel/development_setup.html Problem The install docs don't have instructions on how to check that the install went through correctly. I think,...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/26379
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[doc]: add 'validate' section to install docs","articleBody":"### Documentation Link\r\n\r\nhttps://matplotlib.org/devdocs/devel/development_setup.html\r\n\r\n### Problem\r\n\r\nThe install docs don't have instructions on how to check that the install went through correctly. I think, especially for new contributors, it'd be helpful if we offered a drop more guidance.\r\n\r\n### Suggested improvement\r\n\r\nAdd a new section to https://github.com/matplotlib/matplotlib/blob/main/doc/devel/development_setup.rst after install in editable mode. This section should:\r\n\r\n1. Have instructions for checking that the version that's installed \u003cstrike\u003ematches the last commit `import matplotib; matplotib.__version__`\u003c/strike\u003e is the repo `import matplotlib; matplotlib.__file__`\r\n\r\n3. Link to the running the tests page to verify that the code installed clean: https://github.com/matplotlib/matplotlib/blob/main/doc/devel/testing.rst#L35\r\n4. Link to the building the docs page to verify that the docs build clean: https://github.com/matplotlib/matplotlib/blob/main/doc/devel/document.rst\r\n\r\n\r\nTests and docs should be sentences with links (or a bullet list of table) and not the instructions specifically so that this section acts as an introduction/nudge to those pages and so that we won't have to maintain two sets of instructions.\r\n","author":{"url":"https://github.com/story645","@type":"Person","name":"story645"},"datePublished":"2023-07-24T06:02:48.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":3},"url":"https://github.com/26379/matplotlib/issues/26379"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:fd53224d-ff17-672c-3dca-4a28a449494d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9086:15D6AD:20E1F4:2C8566:6A52726A |
| html-safe-nonce | bfffca6add402d5752bf6d62b2d81cb63adccf23081178c4e24003ff8f6d4351 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MDg2OjE1RDZBRDoyMEUxRjQ6MkM4NTY2OjZBNTI3MjZBIiwidmlzaXRvcl9pZCI6IjI5MjEyNzAwMTczMDI2MjI4MjYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 64085cfbe02ee4d79d64f32640fc91f9a58e16b00e73f0433d501c5797ec0eb2 |
| hovercard-subject-tag | issue:1817698989 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/matplotlib/matplotlib/26379/issue_layout |
| twitter:image | https://opengraph.githubassets.com/7c6e18480335dbd242a0e021af248b7708b7c8616dded97a798586a48f7f9e30/matplotlib/matplotlib/issues/26379 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/7c6e18480335dbd242a0e021af248b7708b7c8616dded97a798586a48f7f9e30/matplotlib/matplotlib/issues/26379 |
| og:image:alt | Documentation Link https://matplotlib.org/devdocs/devel/development_setup.html Problem The install docs don't have instructions on how to check that the install went through correctly. I think, esp... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | story645 |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| turbo-cache-control | no-preview |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | canary-2 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width