updated docs

Author: JarryShaw

README.md

@@ -14,15 +14,16 @@
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
 
+import datetime
 
 # -- Project information -----------------------------------------------------
 
 project = 'lorem'
-copyright = '2020, Jarry Shaw'
+copyright = f'2020-{datetime.datetime.today().year}, Jarry Shaw'  # pylint: disable=redefined-builtin
 author = 'Jarry Shaw'
 
 # The full version, including alpha/beta/rc tags
-release = '1.1.1'
+release = '1.2.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -65,7 +66,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = []  # type: list[str]
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/conf.py

@@ -7,7 +7,7 @@ Pythonic Lorem Ipsum Generator
 ==============================
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 3
 
    lorem
    test_lorem
@@ -40,13 +40,13 @@ The :mod:`lorem` module provides two different ways for getting random words.
 
    .. code-block:: python
 
-      word(count=1, func=None, args=(), kwargs={}) -> Iterator[str]
+      def word(count=1, func=None, args=(), kwargs={}) -> Iterator[str]: ...
 
 2. :func:`~lorem.get_word` -- return random words
 
    .. code-block:: python
 
-      get_word(count=1, sep=' ', func=None, args=(), kwargs={}) -> str
+      def get_word(count=1, sep=' ', func=None, args=(), kwargs={}) -> str: ...
 
 Get Random Sentences
 --------------------
@@ -57,13 +57,13 @@ The :mod:`lorem` module provides two different ways for getting random sentences
 
    .. code-block:: python
 
-      sentence(count=1, comma=(0, 2), word_range=(4, 8)) -> Iterator[str]
+      def sentence(count=1, comma=(0, 2), word_range=(4, 8)) -> Iterator[str]: ...
 
 2. :func:`~lorem.get_sentence` -- return random sentences
 
    .. code-block:: python
 
-      get_sentence(count=1, sep=' ', comma=(0, 2), word_range=(4, 8)) -> Union[str]
+      def get_sentence(count=1, sep=' ', comma=(0, 2), word_range=(4, 8)) -> Union[str]: ...
 
 Get Random Paragraphs
 ---------------------
@@ -74,25 +74,13 @@ The :mod:`lorem` module provides two different ways for getting random paragraph
 
    .. code-block:: python
 
-      paragraph(count=1, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Iterator[str]
+      def paragraph(count=1, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Iterator[str]: ...
 
 2. :func:`~lorem.get_paragraph` -- return random paragraphs
 
    .. code-block:: python
 
-      get_paragraph(count=1, sep=os.linesep, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Union[str]
-
-Customise Word Pool
--------------------
-
-If wanted, the :mod:`lorem` module also provides an interface to customise the word
-pool as you wish.
-
-1. :func:`~lorem.set_pool` -- customise random word pool
-
-   .. code-block:: python
-
-      set_pool(pool)
+      def get_paragraph(count=1, sep=os.linesep, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Union[str]: ...
 
 Indices and tables
 ==================

docs/source/index.rst

@@ -1,10 +1,6 @@
 Lorem Ipsum Generator
 =====================
 
----------------
-Module contents
----------------
-
 Get Random Words
 ----------------
 
@@ -23,12 +19,6 @@ Get Random Paragraphs
 .. autofunction:: lorem.paragraph
 .. autofunction:: lorem.get_paragraph
 
-Customise Word Pool
--------------------
-
-.. autofunction:: lorem.set_pool
-
-------------------
 Internal utilities
 ------------------
 
@@ -44,7 +34,6 @@ Internal utilities
       cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id
       est laborum.
 
-.. autofunction:: lorem._gen_pool
-.. autofunction:: lorem._gen_word
-.. autofunction:: lorem._gen_sentence
-.. autofunction:: lorem._gen_paragraph
+.. autoclass:: lorem.LoremGenerator
+   :show-inheritance:
+   :members:

docs/source/lorem.rst

@@ -3,5 +3,4 @@ Module Unittests
 
 .. automodule:: test_lorem
    :members:
-   :undoc-members:
    :show-inheritance:

docs/source/test_lorem.rst

@@ -71,18 +71,6 @@
 
       get_paragraph(count=1, sep=os.linesep, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10)) -> Union[str]
 
-Customise Word Pool
--------------------
-
-If wanted, the :mod:`lorem` module also provides an interface to customise the word
-pool as you wish.
-
-1. :func:`set_pool` -- customise random word pool
-
-   .. code-block:: python
-
-      set_pool(pool)
-
 """
 import itertools
 import os

lorem.py

@@ -71,21 +71,9 @@
    get_paragraph(count=1, comma=(0, 2), word_range=(4, 8), sentence_range=(5, 10), sep=os.linesep) -> Union[str]
    ```
 
-Customise Word Pool
--------------------
-
-If wanted, the `lorem` module also provides an interface to customise the word
-pool as you wish.
-
-1. `set_pool` -- customise random word pool
-
-   ```python
-   set_pool(pool)
-   ```
-
 """
 # version string
-__version__ = '1.1.2'
+__version__ = '1.2.0'
 
 # setup attributes
 attrs = dict(

setup.py

@@ -12,7 +12,7 @@
 if TYPE_CHECKING:
     from typing import Any, Callable, Iterator, Optional, Sequence
 
-#: Type variable.
+# Type variable.
 _T = TypeVar('_T')
 
 
@@ -49,18 +49,16 @@ def pool(self: 'lorem.LoremGenerator', dupe: 'int' = 1) -> 'Iterator[str]':
 class TestLorem(unittest.TestCase):
     """Unittest case for :mod:`lorem` module."""
 
-    # mock :mod:`random` module functions
-    #: Mock :func:`random.shuffle`
+    # Mock :func:`random.shuffle`
     mock_shuffle = mock.patch('random.shuffle', shuffle)
-    #: Mock :func:`random.randint`
+    # Mock :func:`random.randint`
     mock_randint = mock.patch('random.randint', randint)
-    #: Mock :func:`random.choice` by choosing the first item.
+    # Mock :func:`random.choice` by choosing the first item.
     mock_choice_first = mock.patch('random.choice', choice_first)
-    #: Mock :func:`random.choice` by choosing the last item.
+    # Mock :func:`random.choice` by choosing the last item.
     mock_choice_last = mock.patch('random.choice', choice_last)
 
-    # mock :mod:`lorem` module functions
-    #: Mock :func:`lorem._gen_pool`.
+    # Mock :func:`lorem._gen_pool`.
     mock_pool = mock.patch('lorem.LoremGenerator._gen_pool', pool)
 
     def test_lorem_init(self) -> 'None':