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

Skip to content

[DOC] GitHub spelling and links #24993

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 2, 2023
Merged

Conversation

oscargus
Copy link
Member

PR Summary

Two commits. One spelling GitHub correctly and one adding links for downloading C++-compilers and to example TeX distributions.

Download links is possibly primarily motivated by #24779 where finding/installing a C++-compiler is more tricky than on e.g. linux. The current links where primarily for proving that the stated version for C++-11 support is correct.

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

@oscargus oscargus added this to the v3.7.0 milestone Jan 15, 2023
@tacaswell
Copy link
Member

I have some concerns about adding the links to the compiler and latex installer pages. For the most part people should be getting those through their system package manager not installing "by hand". I worry the intersection of people who need use to give them the links to the compiler download pages and people who will be able to reliable get those to work (I have no faith I could quickly get a user-space install compiler to work) is small to non-existent so by adding this we are going to accidentally send people down very frustrating rabbit holes.

@oscargus
Copy link
Member Author

From a Linux perspective: for sure. It is better to install from a package manager (I think most download pages actually says so as well).

From a Windows perspective: I am not so sure that people really know how to get a compiler up and running in a convenient way. I know on my previous laptop I had three Python versions and at least three compilers available, all in different shells, so getting a single shell where I could build C/C++ for Python was at least a bit challenging. Also, the Build Tools for Visual Studio are probably worth pointing out as they most likely are not that well known and probably the easiest way to get something up and running on Windows (mingw/cygwin clearly more complicated).

Maybe it is better to make specific Windows setup instructions then?

(For LaTeX it is not links to download pages, just two example packages, similar to Inkscape et al, which also should not be installed like that. Worth noting is that Graphviz on the following line actually points to the download page, which probably should be changed then.)

@jklymak
Copy link
Member

jklymak commented Feb 2, 2023

@tacaswell, are you still semi-blocking on this? We already link to compilers and latex packages, so are you advocating removing those, or not updating them? Note this is the developer instructions, so we are allowed to assume some sophistication.

@tacaswell tacaswell merged commit 1367ea5 into matplotlib:main Feb 2, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Feb 2, 2023
@tacaswell
Copy link
Member

I still have some concerns but not enough to block the consensus, merging.

ksunden added a commit that referenced this pull request Feb 2, 2023
…993-on-v3.7.x

Backport PR #24993 on branch v3.7.x ([DOC] GitHub spelling and links)
@ksunden ksunden mentioned this pull request Feb 20, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants