-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Fix typo in URL #8672
Fix typo in URL #8672
Conversation
Previously: - the example wildcard version string was being rendered with a stray space (`== 3.1. *` instead of `== 3.1.*`) due to the markup being split over two lines - the "Dependency Hell" Wikipedia URL 404ed due to the trailing `>`
Co-authored-by: Nguyễn Gia Phong <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://pip--8672.org.readthedocs.build/en/8672/user_guide/#understanding-your-error-message
The 3.1.*
example is now rendered on its own row.
Thank you for the heads up @uranusjr, and I'm sorry for not test the rendering before giving the suggestion. The following should be OK, although it might not be easy edit on some editors (which is why the table was formatted as CSV I believe): +----------+---------------------------------+--------------------------------+
| Operator | Description | Example |
+==========+=================================+================================+
| ``>`` | Any version greater than | ``>3.1``: any version |
| | the specified version. | greater than ``3.1``. |
+----------+---------------------------------+--------------------------------+
| ``<`` | Any version less than | ``<3.1``: any version |
| | the specified version. | less than ``3.1``. |
+----------+---------------------------------+--------------------------------+
| ``<=`` | Any version less than or | ``<=3.1``: any version |
| | equal to the specified version. | less than or equal to ``3.1``. |
+----------+---------------------------------+--------------------------------+
| ``>=`` | Any version greater than or | ``>=3.1``: |
| | equal to the specified version. | version ``3.1`` and greater. |
+----------+---------------------------------+--------------------------------+
| ``==`` | Exactly the specified version. | ``==3.1``: only ``3.1``. |
+----------+---------------------------------+--------------------------------+
| ``!=`` | Any version not equal | ``!=3.1``: any version |
| | to the specified version. | other than ``3.1``. |
+----------+---------------------------------+--------------------------------+
| ``~=`` | Any compatible release. | ``~=3.1``: version ``3.1`` |
| | Compatible releases are | or later, but not |
| | releases that are within the | version ``4.0`` or later. |
| | same major or minor version, | ``~=3.1.2``: version ``3.1.2`` |
| | assuming the package author | or later, but not |
| | is using semantic versioning. | version ``3.2.0`` or later. |
+----------+---------------------------------+--------------------------------+
| ``*`` | Can be used at the end of | ``==3.1.*``: any version |
| | a version number to represent | that starts with ``3.1``. |
| | *all*, | Equivalent to ``~=3.1.0``. |
+----------+---------------------------------+--------------------------------+ |
I see the discussion on the rewrapping of lines taking over and there's 2 fixes here. I'd like to get the URL fix in for 20.2.1 and this is the last outstanding PR for the same. I've removed the rewrapping change from this PR (@edmorley sorry for not checking with you before doing so!) so that we can fix the URL to "Dependency Hell" right now, without waiting on a resolution for the other one. |
Relevant change has been dropped from PR
Previously:
the example wildcard version string was being rendered with a stray space (edited out by @pradyunsg== 3.1. *
instead of== 3.1.*
) due to the markup being split over two lines>