doc: add api docs and docstrings for install_package

eth-brownie · Apr 7, 2020 · cadd053 · cadd053
1 parent fa68c27
commit cadd053
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/brownie/project/main.py b/brownie/project/main.py
@@ -518,6 +518,19 @@ def _install_dependencies(path: Path) -> None:
 
 
 def install_package(package_id: str) -> str:
+    """
+    Install a package.
+
+    Arguments
+    ---------
+    package_id : str
+        Package ID or ethPM URI.
+
+    Returns
+    -------
+    str
+        ID of the installed package.
+    """
     if urlparse(package_id).scheme in ("erc1319", "ethpm"):
         return _install_from_ethpm(package_id)
     else:

diff --git a/docs/api-project.rst b/docs/api-project.rst
@@ -170,6 +170,14 @@ Module Methods
         >>> container.SimpleTest
         <ContractContainer object 'SimpleTest'>
 
+.. py:method:: main.install_package(package_id)
+
+    Install a package.
+
+    See the :ref:`Brownie Package Manager <package-manager>` documentation for more information on packages.
+
+    * ``package_id``: Package identifier or ethPM URI
+
 ``brownie.project.build``
 =========================