Skip to content
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

Add link to PEP-440 version specifiers in documentation #2674

Merged
merged 4 commits into from Aug 5, 2018

Conversation

mic159
Copy link
Contributor

@mic159 mic159 commented Jul 30, 2018

It's currently hard to find the list of version matching operators supported by Pipenv.

I think there should be a link to it in the basics doc under "Specifying Versions of a Package".

@uranusjr
Copy link
Member

uranusjr commented Jul 30, 2018

I think you need one (named) or two (unnamed) underscores after the hyperlink. I would strongly recommend using the out-of-line named syntax as well:

blah blah `my link`_

.. _`my link`: https://my.link

More information can be found here.

Also, if the text is “PEP 440”, I would simply link to the page; if you want to link to the section specifically, I would alter the text to something like “relevant section in PEP 440“.

Thanks so much fo the contribution! I ❤️ documentation patches.

@techalchemy techalchemy added Type: Documentation 📖 This issue relates to documentation of pipenv. Type: Regression This issue is a regression of a previous behavior. PR: awaiting-news The PR related to this issue is missing a news fragment and cannot be merged. PR: awaiting-merge The PR related to this issue has been reviewed and is awaiting merge. and removed Type: Regression This issue is a regression of a previous behavior. labels Aug 4, 2018
@techalchemy techalchemy merged commit ea8a8f4 into pypa:master Aug 5, 2018
techalchemy added a commit that referenced this pull request Aug 5, 2018
Signed-off-by: Dan Ryan <dan@danryan.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: awaiting-merge The PR related to this issue has been reviewed and is awaiting merge. PR: awaiting-news The PR related to this issue is missing a news fragment and cannot be merged. Type: Documentation 📖 This issue relates to documentation of pipenv.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants