Skip to content

Commit

Permalink
Merge pull request #2792 from reinout/reinout-fixed-missing-egg-in-url
Browse files Browse the repository at this point in the history
Added missing 'egg=' in the example url
  • Loading branch information
uranusjr committed Aug 30, 2018
2 parents 4f1f669 + 505d093 commit afc9bfc
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ the current working directory when working on packages::
"e1839a8" = {path = ".", editable = true}
...

.. note:: All sub-dependencies will get added to the ``Pipfile.lock`` as well. Sub-dependencies are **not** added to the
.. note:: All sub-dependencies will get added to the ``Pipfile.lock`` as well. Sub-dependencies are **not** added to the
``Pipfile.lock`` if you leave the ``-e`` option out.


Expand Down Expand Up @@ -336,7 +336,7 @@ If you experience issues with ``$ pipenv shell``, just check the ``PIPENV_SHELL`

You can install packages with pipenv from git and other version control systems using URLs formatted according to the following rule::

<vcs_type>+<scheme>://<location>/<user_or_organization>/<repository>@<branch_or_tag>#<package_name>
<vcs_type>+<scheme>://<location>/<user_or_organization>/<repository>@<branch_or_tag>#egg=<package_name>

The only optional section is the ``@<branch_or_tag>`` section. When using git over SSH, you may use the shorthand vcs and scheme alias ``git+git@<location>:<user_or_organization>/<repository>@<branch_or_tag>#<package_name>``. Note that this is translated to ``git+ssh://git@<location>`` when parsed.

Expand Down
3 changes: 3 additions & 0 deletions news/2792.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Fixed the example url for doing "pipenv install -e
some-repo-url#egg=something", it was missing the "egg=" in the fragment
identifier.

0 comments on commit afc9bfc

Please sign in to comment.