updated documentation

docs/conf.py

@@ -15,8 +15,10 @@
     "sphinx_copybutton",
 ]
 html_static_path = ["_static"]
-copybutton_prompt_text = r">>> |\$ "
+copybutton_prompt_text = r">>> |\$ |\.\.\. "
 copybutton_prompt_is_regexp = True
+copybutton_only_copy_prompt_lines = False
+
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
     "github_url": "https://github.com/rajivsarvepalli/mock-alchemy",

docs/contributor_guide/index.rst

@@ -7,7 +7,7 @@ This project welcomes contributions and suggestions. Feel free to suggest any ch
 or add new features. The easiest way is simply through GitHub itself with the issues tab. These suggestions or bugs
 can be reported and then addressed. If you want to contribute, you can simply submit a pull-request or make your own package
 of this software through forking. Pull-requests are the easiest manner in which to contribute along with appropriate issue labels
-which enable a quicker release with release drafter..
+which enable a quicker release with release drafter.
 
 Any suggestions are welcome along with any suggestions or contributions.
 
@@ -17,7 +17,7 @@ Dependencies
 To develop, there is a much longer list of dependencies than just for the package mainly for the purposes of linting and testing.
 
 The ones to download separately are ``tox``, ``poetry``, and ``pre-commit``. They need to be installed and then the poetry can be used to build and install the project.
-``poetry install`` can be used to install in the project in the poetry virtual environment for development. Then tox can be used for testing and pre-commit for
+``poetry install`` can be used to install the project in the poetry virtual environment for development. Then tox can be used for testing and pre-commit for
 linting. `Poetry <https://python-poetry.org/>`__ is used for easy publishing and managing dependencies in a simpler manner than just pure setuptools.
 
 The major libraries used are ``tox``, ``flake8``, ``poetry``, and ``pre-commit``. A full list is available in ``requirements-dev.txt``.
@@ -27,11 +27,11 @@ Future Plans
 
 In the near future, I intend to drop support for Python 2 and move to Python 3.7 and above for newer releases. The idea is to keep a branch of release-0.1
 that will support Python 2.7, 3.6, and 3.7. This branch will be updated with whatever hotfixes are required and new features are requested. Pull-requests to this branch
-will allow for a new release of 0.1.x version of this package. Any 0.1.x version, as stated before, will support Python 2.7, 3.6, and 3.7. However, the future releases
+will allow for a new release of the 0.1.x version of this package. Any 0.1.x version, as stated before, will support Python 2.7, 3.6, and 3.7. However, the future releases
 of > 0.1 will only support Python 3.7 and up.
 
 For the newer releases, type annotations are planned along with other Python 3.7+ features.
 
 Along with this upgrade, many of the tools inside this project have upgraded versions or more modernized alternatives. One major upgrades/changes includes
-upgrading `tox <https://tox.readthedocs.io/en/latest/>`__ to `nox <https://nox.thea.codes/en/stable/>`__. Additional changes may include adding flake8 plugins such
+upgrading `tox <https://tox.readthedocs.io/en/latest/>`__ to `nox <https://nox.thea.codes/en/stable/>`__. Additional alterations may include adding flake8 plugins such
 as ``flake8-bandit``, ``flake8-docstrings``, ``flake8-annotations``, and so on.

docs/index.rst

@@ -23,7 +23,7 @@ mock-alchemy documentation
 `Source Repository <https://github.com/rajivsarvepalli/mock-alchemy>`__ |
 `Issues & Ideas <https://github.com/rajivsarvepalli/mock-alchemy/issues>`__
 
-:mod:`mock_alchemy` is an open source, MIT-licensed library providing simple method of mocking SQLAlchemy sessions and gives the ability to do sane asserts.
+:mod:`mock_alchemy` is an open-source, MIT-licensed library providing a simple method of mocking SQLAlchemy sessions and gives the ability to do sane asserts.
 
 .. raw:: html
 
@@ -75,7 +75,7 @@ mock-alchemy documentation
                 <div class="card-body flex-fill">
                     <h5 class="card-title">API reference</h5>
                     <p class="card-text">The reference guide contains a specific description of
-                    the mock-alchemy API.This reference API describes how certain functions work and provides basic examples
+                    the mock-alchemy API. This reference API describes how certain functions work and provides basic examples
                     to illustrate what functions do.</p>
 
 .. container:: custom-button
@@ -92,7 +92,7 @@ mock-alchemy documentation
                 <img src="_static/index_contribute.svg" class="card-img-top" alt="contribute to mock-alchemy action icon" height="72">
                 <div class="card-body flex-fill">
                     <h5 class="card-title">Contributor guide</h5>
-                    <p class="card-text">Interesed in making improvements to this package? The process for suggesting and making changes is described in more detail here along
+                    <p class="card-text">Interesed in making improvements to this library? The process for suggesting and making changes is described in more detail here along
                     with the required development dependencies.</p>
 
 .. container:: custom-button

docs/user_guide/index.rst

@@ -5,6 +5,13 @@ User Guide
 
 There several major uses for this package and I will try to detail out several examples in this guide.
 
+Installation
+--------------
+
+You can install ``mock-alchemy`` using pip::
+
+    $ pip install mock-alchemy
+
 Quick Examples
 --------------
 
@@ -348,7 +355,7 @@ to check branching in code and verify data values using a mock SqlAlchemy sessio
 Getting and Deleting
 ^^^^^^^^^^^^^^^^^^^^
 
-Let us return the :ref:`previous example <data_stubbing>`, but now we can test deleting as well.
+Let us reuse the :ref:`previous example <data_stubbing>`, but now we can test deleting as well.
 We modify the ``complex_data_analysis`` to be:
 
 .. code-block:: python