Merge pull request #7917 from deveshks/fix-docs-for-pip-usage-in-program

Clarify use of freeze in pip in program example
pypa · Mar 28, 2020 · 4381493 · 4381493
2 parents e1e5588 + be2268e
commit 4381493
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/html/user_guide.rst b/docs/html/user_guide.rst
@@ -814,8 +814,8 @@ This is easily done using the standard ``subprocess`` module::
 
   subprocess.check_call([sys.executable, '-m', 'pip', 'install', 'my_package'])
 
-If you want to process the output further, use one of the other APIs in the
-module::
+If you want to process the output further, use one of the other APIs in the module.
+We are using `freeze`_ here which outputs installed packages in requirements format.::
 
   reqs = subprocess.check_output([sys.executable, '-m', 'pip', 'freeze'])
 
@@ -832,3 +832,5 @@ of ability. Some examples that you could consider include:
 
 * ``distlib`` - Packaging and distribution utilities (including functions for
   interacting with PyPI).
+
+.. _freeze: https://pip.pypa.io/en/latest/reference/pip_freeze/
diff --git a/news/7008.doc b/news/7008.doc
@@ -0,0 +1 @@
+Clarify the usage of freeze command in the example of Using pip in your program
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify the usage of freeze command in the example of Using pip in your program