Updated docs.

Author: domdfcoding

doc-source/api/words.rst

@@ -7,6 +7,10 @@
 
 .. automodulesumm:: domdf_python_tools.words
 
+.. autovariable:: domdf_python_tools.words.CR
+.. autovariable:: domdf_python_tools.words.LF
+.. autovariable:: domdf_python_tools.words.TAB
+
 .. autovariable:: domdf_python_tools.words.ascii_digits
 .. autovariable:: domdf_python_tools.words.greek_uppercase
 .. autovariable:: domdf_python_tools.words.greek_lowercase

domdf_python_tools/bases.py

@@ -132,13 +132,13 @@ class UserList(MutableSequence[_T]):
 
 	Class that simulates a list. The instance’s contents are kept in a regular list,
 	which is accessible via the :attr:`~.UserList.data` attribute of UserList instances.
-	The instance’s contents are initially set to a copy of list, defaulting to the
-	empty list ``[]``.
+	The instance’s contents are initially set to a copy of list, defaulting to the empty list ``[]``.
+
+	.. versionadded:: 0.10.0
 
 	:param initlist: Values to initialise the :class:`~domdf_python_tools.bases.UserList` with.
 	:default initlist: ``[]``
 
-
 	.. admonition:: Subclassing requirements
 
 		Subclasses of UserList are expected to offer a constructor which can be called with
@@ -150,8 +150,6 @@ class UserList(MutableSequence[_T]):
 		If a derived class does not wish to comply with this requirement, all of the special
 		methods supported by this class will need to be overridden; please consult the
 		sources for information about the methods which need to be provided in that case.
-
-	.. versionadded:: 0.10.0
 	"""
 
 	#: A real list object used to store the contents of the :class:`~domdf_python_tools.bases.UserList`.
@@ -371,11 +369,11 @@ def extend(self, other: Iterable[_T]) -> None:
 @prettify_docstrings
 class UserFloat(Real):
 	"""
-	Class that simulates a float.
-
-	:param value: Values to initialise the :class:`~domdf_python_tools.bases.UserFloat` with.
+	Class which simulates a float.
 
 	.. versionadded:: 1.6.0
+
+	:param value: Values to initialise the :class:`~domdf_python_tools.bases.UserFloat` with.
 	"""
 
 	def __init__(self, value: Union[SupportsFloat, SupportsIndex, str, bytes, bytearray] = 0.0):
@@ -471,6 +469,16 @@ def __trunc__(self) -> int:
 		return float(self).__trunc__()
 
 	def __round__(self, ndigits: Optional[int] = None) -> Union[int, float]:  # type: ignore
+		"""
+		Round the :class:`~.UserFloat` to ``ndigits`` decimal places, defaulting to ``0``.
+
+		If ``ndigits`` is omitted or :py:obj:`None`, returns an :class:`int`,
+		otherwise returns a :class:`float`.
+		Rounds half toward even.
+
+		:param ndigits:
+		"""
+
 		return float(self).__round__(ndigits)
 
 	def __eq__(self, other: object) -> bool:
@@ -548,9 +556,11 @@ def __bool__(self) -> bool:
 
 	def __complex__(self) -> complex:
 		"""
-		Returrn :func:`complex(self) <complex>``.
+		Return :class:`complex(self) <complex>`.
+
+		.. code-block:: python
 
-		``complex(self) == complex(float(self), 0)``
+			complex(self) == complex(float(self), 0)
 		"""
 
 		return super().__complex__()

domdf_python_tools/dates.py

@@ -243,9 +243,9 @@ def calc_easter(year: int) -> datetime.date:
 	"""
 	Returns the date of Easter in the given year.
 
-	:param year:
-
 	.. versionadded:: 1.4.0
+
+	:param year:
 	"""
 
 	a = year % 19

domdf_python_tools/doctools.py

@@ -307,15 +307,13 @@ def wrapper(target: F) -> F:
 
 def _do_prettify(obj: Type, base: Type, new_docstrings: Dict[str, str]):
 	"""
-	Perform the actual prettification for :func`~.prettify_docstrings`.
+	Perform the actual prettifying for :func`~.prettify_docstrings`.
+
+	.. versionadded:: 0.8.0
 
 	:param obj:
 	:param base:
 	:param new_docstrings:
-
-	:rtype:
-
-	.. versionadded:: 0.8.0
 	"""
 
 	for attr_name in new_docstrings:
@@ -349,11 +347,9 @@ def prettify_docstrings(obj: Type) -> Type:
 	"""
 	Decorator to prettify the default :class:`object` docstrings for use in Sphinx documentation.
 
-	:param obj: The object to prettify the method docstrings for.
-
-	:rtype:
-
 	.. versionadded:: 0.8.0
+
+	:param obj: The object to prettify the method docstrings for.
 	"""
 
 	repr_docstring = f"Return a string representation of the :class:`~{obj.__module__}.{obj.__name__}`."

domdf_python_tools/import_tools.py

@@ -148,14 +148,14 @@ def discover_entry_points(
 	"""
 	Returns a list of entry points in the given category, optionally filtered by ``match_func``.
 
+	.. versionadded:: 1.1.0
+
 	:param group_name: The entry point group name, e.g. ``'entry_points'``.
 	:param match_func: Function taking an object and returning :py:obj:`True`
 		if the object is to be included in the output.
 	:default match_func: :py:obj:`None`, which includes all objects.
 
 	:return: List of matching objects.
-
-	.. versionadded:: 1.1.0
 	"""
 
 	matching_objects = []