DOC: concise dependency heading + small clarifications by story645 · Pull Request #27058 · matplotlib/matplotlib · GitHub

PR summary

This PR simplifies the titles of a couple of sections on the dependency page, mostly by removing building and Matplotlib because I think those are a given cause it's the dependency page. It makes the right hand side more scannable.
-->

PR checklist

"closes #0000" is in the body of the PR description to link the related issue
new and changed code is tested
Plotting related features are demonstrated in an example
New Features and API Changes are noted with a directive and release note
Documentation complies with general and docstring guidelines

OK, based on @jklymak's comment I went and looked and there was only one ref I had to updated. Generally we either link to the whole page (which would remain dependencies) or use custom link text geared to the context of the paragraph. That being the case, I really prefer the short titles. Currently the page has longer titles for subheadings and "topic" titles for the subsubheadings:

I agree that the right menu is more verbose than need be, e.g. we don't need "Matplotlib" in there. But the proposed version does not contain the word "dependencies" at all.

I suggest to keep it at least on the section titles:

On this page
- Runtime dependencies
  - Mandatory
  - Optional
  - C libraries
  - ...
- Build dependencies
- Test dependencies
- Documentation dependencies

I suggest to keep it at least on the section titles:

that sounds like a reasonable compromise to me. Going roughly with that, I end up here: (+- tweaks to testing to make it like the others)

Also changed/cleaned up some language and uh I have no idea why that pip/many linux paragraph is in this doc.

Take or leave my comments.

Not quite sure whether "install" is the right term here. But I don't have an alternative either.

yeah, it was more that Manual download reallly doesn't mean anything here

use source might be better?

I don't want to over-think this, but "source" is a quite generic term. IMHO good headings would be

C libraries
- Automatic download (this section header is missing but should be added)
- Use system libraries
- From source files (or "Custom source files")

I agree with you so I'll make the change.

also "Matplotlib vendored version" or the like is probably is better for "Auto download" so I'm going with that.

Made the changes, but probably would be good for @QuLogic to take a quick glance to make sure I didn't lose anything

@QuLogic does #26621 (comment) mean that I should remove the line about Aix being an exception in the section about MPL vendored freetype?

Yes, I noticed that here, which is why I asked them. Since it looks like we won't need to keep the special-casing, we can drop that from the docs.

Thanks! Also, is the section about pip/manylinux still applicable?

This part https://github.com/matplotlib/matplotlib/blob/93b713b8b9c1a3f6a180126d22e676313a4940d0/doc/devel/dependencies.rst#minimum-pip--manylinux-support-linux? It has not changed, I don't think.

I think it just didn't feel like it fits w/ the other dependencies, but if it's alright than I don't think there's anything left to change.

Not sure why this colon is here?

accident, but also I went and unpacked the sentences above to try and make it very explicit that most folks should not need to install the build dependencies.

note required MinGW windows header version Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.8.x
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 b1857a13c04beab777f84e0f8810ecd8f5cfc512

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #27058: DOC: concise dependency heading + small clarifications'

Push to a named branch:

git push YOURFORK v3.8.x:auto-backport-of-pr-27058-on-v3.8.x

Create a PR against branch v3.8.x, I would have named this PR:

"Backport PR #27058 on branch v3.8.x (DOC: concise dependency heading + small clarifications)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.8.0-doc
git pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 b1857a13c04beab777f84e0f8810ecd8f5cfc512

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am 'Backport PR #27058: DOC: concise dependency heading + small clarifications'

Push to a named branch:

git push YOURFORK v3.8.0-doc:auto-backport-of-pr-27058-on-v3.8.0-doc

Create a PR against branch v3.8.0-doc, I would have named this PR:

"Backport PR #27058 on branch v3.8.0-doc (DOC: concise dependency heading + small clarifications)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

IMHO not worth a manual backport.

IMHO not worth a manual backport

Yeah this mentions meson and that's milestoned to 3.9.

story645 added the Documentation: devdocs files in doc/devel label Oct 11, 2023

QuLogic reviewed Oct 11, 2023

View reviewed changes

Comment thread doc/devel/dependencies.rst Outdated

story645 force-pushed the dep-headings branch 2 times, most recently from 63a9257 to a1a9e37 Compare October 11, 2023 03:23

timhoffm reviewed Oct 11, 2023

View reviewed changes

Comment thread doc/devel/dependencies.rst Outdated

story645 force-pushed the dep-headings branch from fcdeaa0 to dc066a0 Compare October 11, 2023 20:02

story645 changed the title DOC: made dependency section headings concise DOC: concise dependency heading + small clarifications Oct 11, 2023

story645 force-pushed the dep-headings branch from dc066a0 to e60394b Compare October 11, 2023 20:04

timhoffm approved these changes Oct 11, 2023

View reviewed changes

story645 force-pushed the dep-headings branch from d2a56c9 to 2d2bef9 Compare October 11, 2023 20:52

story645 mentioned this pull request Oct 12, 2023

Added info for getting compilation output from meson on autorebuild #27053

Merged

1 task done

story645 force-pushed the dep-headings branch from fc5e7d6 to 2d91bb2 Compare October 12, 2023 17:02

story645 force-pushed the dep-headings branch 2 times, most recently from 99e3d53 to 2b7439e Compare October 17, 2023 00:25

story645 force-pushed the dep-headings branch from 2b7439e to 93b713b Compare October 18, 2023 07:02

QuLogic reviewed Oct 19, 2023

View reviewed changes

reduced redundancy in headings and

0a139a0

note required MinGW windows header version Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

story645 force-pushed the dep-headings branch from 08426b7 to 0a139a0 Compare October 20, 2023 04:18

timhoffm approved these changes Oct 20, 2023

View reviewed changes

timhoffm added this to the v3.8-doc milestone Oct 20, 2023

timhoffm merged commit b1857a1 into matplotlib:main Oct 20, 2023

lumberbot-app Bot added the Still Needs Manual Backport label Oct 20, 2023

timhoffm modified the milestones: v3.8-doc, v3.9.0 Oct 20, 2023

timhoffm removed the Still Needs Manual Backport label Oct 20, 2023

story645 deleted the dep-headings branch October 20, 2023 13:18

-              Manual Download
-              ^^^^^^^^^^^^^^^
+              Install from source

		in the target environment manually.
		:

DOC: concise dependency heading + small clarifications by story645 · Pull Request #27058 · matplotlib/matplotlib · GitHub

Uh oh!

DOC: concise dependency heading + small clarifications - #27058

DOC: concise dependency heading + small clarifications#27058timhoffm merged 1 commit intomatplotlib:mainmatplotlib/matplotlib:mainfrom story645:dep-headingsstory645/matplotlib:dep-headingsCopy head branch name to clipboard

Conversation

story645 commented Oct 11, 2023

PR summary

PR checklist

Uh oh!

Uh oh!

Uh oh!

story645 commented Oct 11, 2023

Uh oh!

timhoffm commented Oct 11, 2023

Uh oh!

story645 commented Oct 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timhoffm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

timhoffm Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

story645 Oct 11, 2023

Choose a reason for hiding this comment

Uh oh!

story645 Oct 12, 2023

Choose a reason for hiding this comment

Uh oh!

timhoffm Oct 16, 2023

Choose a reason for hiding this comment

Uh oh!

story645 Oct 17, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

story645 Oct 17, 2023

Choose a reason for hiding this comment

Uh oh!

story645 commented Oct 16, 2023

Uh oh!

story645 commented Oct 17, 2023

Uh oh!

QuLogic commented Oct 18, 2023

Uh oh!

story645 commented Oct 18, 2023

Uh oh!

QuLogic commented Oct 18, 2023

Uh oh!

story645 commented Oct 18, 2023

Uh oh!

QuLogic Oct 19, 2023

Choose a reason for hiding this comment

Uh oh!

story645 Oct 20, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lumberbot-app Bot commented Oct 20, 2023

Uh oh!

lumberbot-app Bot commented Oct 20, 2023

Uh oh!

timhoffm commented Oct 20, 2023

Uh oh!

story645 commented Oct 20, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

DOC: concise dependency heading + small clarifications#27058
timhoffm merged 1 commit into
matplotlib:mainfrom
story645:dep-headings

story645 commented Oct 11, 2023 •
edited
Loading

story645 Oct 17, 2023 •
edited
Loading