Add WIP note

pypa · Aug 22, 2019 · 289af52 · 289af52
1 parent 9b82fcc
commit 289af52
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/html/development/architecture/anatomy.rst b/docs/html/development/architecture/anatomy.rst
@@ -1,3 +1,7 @@
+.. note::
+    This section of the documentation is currently being written. pip
+    developers welcome your help to complete this documentation. If you're
+    interested in helping out, please let us know in the `tracking issue`_.
 
 ****************************************
 Repository anatomy & directory structure
@@ -97,6 +101,7 @@ Within ``src/``:
 
   * ``_vendor/`` *[code from other packages -- pip’s own dependencies…. Has them in its own source tree, because pip cannot depend on pip being installed on the machine already!]*
 
+.. _`tracking issue`: https://github.com/pypa/pip/issues/6831
 .. _GitHub repository: https://github.com/pypa/pip/
 .. _tox.ini: https://github.com/pypa/pip/blob/master/tox.ini
 .. _improving the pip dependency resolver: https://github.com/pypa/pip/issues/988
diff --git a/docs/html/development/architecture/overview.rst b/docs/html/development/architecture/overview.rst
@@ -1,3 +1,8 @@
+.. note::
+    This section of the documentation is currently being written. pip
+    developers welcome your help to complete this documentation. If you're
+    interested in helping out, please let us know in the `tracking issue`_.
+
 .. contents::
 
 ****************************
@@ -132,6 +137,7 @@ whole list?
 Answer: It's not every file, just files of Flask. No API for getting alllllll
 files on PyPI. It’s for getting all files of Flask.)
 
+.. _`tracking issue`: https://github.com/pypa/pip/issues/6831
 .. _PyPI: https://pypi.org/
 .. _PyPI Simple API: https://warehouse.readthedocs.io/api-reference/legacy/#simple-project-api