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

Fix typo in URL #8672

Merged
merged 3 commits into from
Aug 4, 2020
Merged

Fix typo in URL #8672

merged 3 commits into from
Aug 4, 2020

Conversation

edmorley
Copy link
Contributor

@edmorley edmorley commented Jul 31, 2020

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 edited out by @pradyunsg
  • the "Dependency Hell" Wikipedia URL 404ed due to the trailing >

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 `>`
docs/html/user_guide.rst Outdated Show resolved Hide resolved
Co-authored-by: Nguyễn Gia Phong <[email protected]>
@pradyunsg pradyunsg added the type: docs Documentation related label Aug 2, 2020
@pradyunsg pradyunsg modified the milestones: 20.2, 20.2.1 Aug 2, 2020
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

@McSinyx
Copy link
Contributor

McSinyx commented Aug 2, 2020

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``.     |
+----------+---------------------------------+--------------------------------+

docs/html/user_guide.rst Outdated Show resolved Hide resolved
@pradyunsg pradyunsg changed the title Fix typos in the docs about conflicting dependencies Fix typo in URL Aug 4, 2020
@pradyunsg
Copy link
Member

pradyunsg commented Aug 4, 2020

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.

@pradyunsg pradyunsg dismissed uranusjr’s stale review August 4, 2020 01:46

Relevant change has been dropped from PR

@pradyunsg pradyunsg merged commit d8ba146 into pypa:master Aug 4, 2020
pradyunsg added a commit to pradyunsg/pip that referenced this pull request Aug 4, 2020
@edmorley edmorley deleted the fix-userguide-typos branch August 4, 2020 21:00
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants