remove version numbers from docs, minor updates

eth-brownie · Jan 30, 2020 · ea242ba · ea242ba
1 parent 93e7004
commit ea242ba
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 17 deletions.
diff --git a/docs/api-test.rst b/docs/api-test.rst
@@ -141,7 +141,7 @@ RevertContextManager
 
 The ``RevertContextManager`` closely mimics the behaviour of `pytest.raises <https://docs.pytest.org/en/latest/reference.html#pytest-raises>`_.
 
-.. py:class:: plugin.RevertContextManager(revert_msg=None)
+.. py:class:: brownie.test.plugin.RevertContextManager(revert_msg=None)
 
     Context manager used to handle :func:`VirtualMachineError <brownie.exceptions.VirtualMachineError>` exceptions. Raises ``AssertionError`` if no transaction has reverted when the context closes.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -31,7 +31,7 @@ def setup(sphinx):
 
 
 project = "Brownie"
-copyright = "2019"
+copyright = "2020"
 author = "Ben Hauser"
 
 # The short X.Y version

diff --git a/docs/ethpm.rst b/docs/ethpm.rst
@@ -60,7 +60,7 @@ To view a list of currently installed packages within a project:
 ::
 
     $ brownie ethpm list
-    Brownie v1.2.0 - Python development framework for Ethereum
+    Brownie - Python development framework for Ethereum
 
     Found 2 installed packages:
      ├─access@1.0.0
@@ -71,7 +71,7 @@ Any packages that are installed from a registry are also saved locally. To view
 ::
 
     $ brownie ethpm all
-    Brownie v1.1.0 - Python development framework for Ethereum
+    Brownie - Python development framework for Ethereum
 
     erc1319://erc20.snakecharmers.eth
      └─dai-dai@1.0.0
@@ -262,7 +262,7 @@ Once the package is successfully released, Brownie provides you with a registry
 ::
 
     $ brownie ethpm release erc20.snakecharmers.eth registry_owner
-    Brownie v1.1.0 - Python development framework for Ethereum
+    Brownie - Python development framework for Ethereum
 
     Generating manifest and pinning assets to IPFS...
     Pinning "NFToken.sol"...

diff --git a/docs/install.rst b/docs/install.rst
@@ -21,7 +21,7 @@ Once you have installed, type ``brownie`` to verify that it worked:
 ::
 
     $ brownie
-    Brownie v1.0.0 - Python development framework for Ethereum
+    Brownie - Python development framework for Ethereum
 
     Usage:  brownie <command> [<args>...] [options <args>]
 

diff --git a/docs/interaction.rst b/docs/interaction.rst
@@ -6,9 +6,9 @@ Interacting with your Contracts
 
 Brownie has three main components that you can use while developing your project:
 
-1. The :ref:`console<console>` is useful for quick testing and debugging.
-2. :ref:`Scripts<scripts>` allow you to automate common tasks and handle deployments.
-3. :ref:`Tests<tests-intro>` help to ensure that your contracts are executing as intended and do not contain any bugs.
+    1. The :ref:`console<console>` is useful for quick testing and debugging.
+    2. :ref:`Scripts<scripts>` allow you to automate common tasks and handle deployments.
+    3. :ref:`Tests<tests-intro>` help to ensure that your contracts are executing as intended and do not contain any bugs.
 
 .. _console:
 

diff --git a/docs/structure.rst b/docs/structure.rst
@@ -6,16 +6,16 @@ Structure of a Project
 
 Every Brownie project includes the following folders:
 
-* ``contracts/``: Contract sources
-* ``interfaces/``: Interface sources
-* ``scripts/``: Scripts for deployment and interaction
-* ``tests/``: Scripts for testing the project
-* ``brownie-config.yaml``: Configuration file for the project
+    * ``contracts/``: Contract sources
+    * ``interfaces/``: Interface sources
+    * ``scripts/``: Scripts for deployment and interaction
+    * ``tests/``: Scripts for testing the project
+    * ``brownie-config.yaml``: Configuration file for the project
 
 The following folders are also created, and used internally by Brownie for managing the project. You should not edit or delete files within these folders.
 
-* ``build/``: Project data such as compiler artifacts and unit test results
-* ``reports/``: JSON report files for use in the GUI
+    * ``build/``: Project data such as compiler artifacts and unit test results
+    * ``reports/``: JSON report files for use in the GUI
 
 See :ref:`build-folder` for more information about Brownie internal project folders.
 

diff --git a/docs/tests-pytest.rst b/docs/tests-pytest.rst
@@ -125,7 +125,7 @@ For example - if your project contains a contract named ``Token``, there will be
 Handling Reverted Transactions
 ==============================
 
-When running tests, transactions that revert raise a :func:`VirtualMachineError <brownie.exceptions.VirtualMachineError>` exception. To write assertions around this you can use ``brownie.reverts`` as a context manager. It functions very similarly to `pytest.raises <https://docs.pytest.org/en/latest/assert.html#assertraises>`_.
+When running tests, transactions that revert raise a :func:`VirtualMachineError <brownie.exceptions.VirtualMachineError>` exception. To write assertions around this you can use :func:`brownie.reverts <brownie.test.plugin.RevertContextManager>` as a context manager. It functions very similarly to `pytest.raises <https://docs.pytest.org/en/latest/assert.html#assertraises>`_.
 
 
 .. code-block:: python