Skip to content

Commit f637939

Browse files
committed
Updated docs.
1 parent 3534448 commit f637939

File tree

5 files changed

+7
-9
lines changed

5 files changed

+7
-9
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
2-
31
==============
42
Contributing
53
==============
64

5+
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
6+
77
``domdf_python_tools`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
88

99
Install ``pre-commit`` with ``pip`` and install the git hook:

doc-source/api/words.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ Functions for working with (English) words.
1515
.. autofunction:: domdf_python_tools.words.get_words_list
1616
.. autofunction:: domdf_python_tools.words.get_random_word
1717
.. autofunction:: domdf_python_tools.words.make_font
18-
.. autofunction:: domdf_python_tools.words.as_font
1918

2019
.. autoclass:: domdf_python_tools.words.Font
2120
:special-members:

doc-source/contributing.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
1+
Overview
2+
---------
23

3-
==============
4-
Contributing
5-
==============
4+
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
65
76
``domdf_python_tools`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
87

doc-source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Installation
142142

143143
.. toctree::
144144
:maxdepth: 3
145-
:caption: Documentation
145+
:caption: Contributing
146146

147147
contributing
148148
Source

domdf_python_tools/typing.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050

5151
def check_membership(obj: Any, type_: Union[Type, object]) -> bool:
5252
"""
53-
Check if the type of ``obj`` is one of the types in a :py:data:`typing.Union`, :typing.sequence:`Sequence` etc.
53+
Check if the type of ``obj`` is one of the types in a :py:data:`typing.Union`, :class:`typing.Sequence` etc.
5454
5555
:param obj: The object to check the type of
5656
:param type_: A :class:`~typing.Type` that has members, such as a List, Union or Sequence.

0 commit comments

Comments
 (0)