Improve documentation in misc.py

pypa · Oct 29, 2018 · 4ccea7e · 4ccea7e
1 parent bc5ac33
commit 4ccea7e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/news/C32E6CBD-7420-43A9-9A9B-607F7F7B5D90.trivial b/news/C32E6CBD-7420-43A9-9A9B-607F7F7B5D90.trivial
diff --git a/src/pip/_internal/utils/misc.py b/src/pip/_internal/utils/misc.py
@@ -322,7 +322,9 @@ def dist_in_site_packages(dist):
 
 
 def dist_is_editable(dist):
-    """Is distribution an editable install?"""
+    """
+    Return True if given Distribution is an editable install.
+    """
     for path_item in sys.path:
         egg_link = os.path.join(path_item, dist.project_name + '.egg-link')
         if os.path.isfile(egg_link):