Skip to content

Fix broken contributing link on PyPI#726

Merged
cjolowicz merged 2 commits intocjolowicz:mainfrom
staticdev:bug/fix-broken-pypi-contributing-link
Dec 11, 2021
Merged

Fix broken contributing link on PyPI#726
cjolowicz merged 2 commits intocjolowicz:mainfrom
staticdev:bug/fix-broken-pypi-contributing-link

Conversation

@staticdev
Copy link
Copy Markdown
Contributor

@staticdev staticdev commented Dec 8, 2021

Closes cjolowicz/cookiecutter-hypermodern-python#1091

Copy link
Copy Markdown
Owner

@cjolowicz cjolowicz left a comment

Choose a reason for hiding this comment

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

Thanks for catching this!

The problem with your approach is that it will silently switch versions on Read the Docs.

@cjolowicz
Copy link
Copy Markdown
Owner

Better keep the github-only marker and use the full GitHub URL (main branch) instead of a relative link.

pros:

  • RTD versioning isn't broken by silently switching to latest
  • GitHub readers stay on GitHub

cons:

  • GitHub readers might switch branch when clicking the link

I think the pros outweigh the cons.

Like you say, PyPI readers will get the GitHub version which is less polished. But it's the Contributor Guide, contributors want to go to GitHub anyway 😉

@staticdev
Copy link
Copy Markdown
Contributor Author

@cjolowicz oh I see the problem. Ok, I fix that later today.

@cjolowicz cjolowicz merged commit f0019bc into cjolowicz:main Dec 11, 2021
Copy link
Copy Markdown
Owner

@cjolowicz cjolowicz 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!

@staticdev staticdev deleted the bug/fix-broken-pypi-contributing-link branch December 11, 2021 17:17
@cjolowicz cjolowicz added the documentation Improvements or additions to documentation label Dec 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken link on PyPI for Contributor Guide

2 participants