Updated docs.

Author: domdfcoding

domdf_python_tools/doctools.py

@@ -305,6 +305,8 @@ def _do_prettify(obj: Type, base: Type, new_docstrings: Dict[str, str]):
 	:param new_docstrings:
 
 	:return:
+
+	.. versionadded:: 0.8.0
 	"""
 
 	for attr_name in new_docstrings:
@@ -328,7 +330,7 @@ def prettify_docstrings(obj: Type) -> Type:
 
 	:return: The object
 
-	Default :func:`dir` implementation.
+	.. versionadded:: 0.8.0
 	"""
 
 	repr_docstring = f"Return a string representation of the :class:`~{obj.__module__}.{obj.__name__}`."

domdf_python_tools/stringlist.py

@@ -3,6 +3,11 @@
 #  stringlist.py
 """
 A list of strings that represent lines in a multiline string.
+
+.. versionchanged:: 0.8.0
+
+	String moved to :mod:`domdf_python_tools.typing`.
+	It will be removed from this module in 1.0.0
 """
 #
 #  Copyright © 2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
@@ -31,7 +36,6 @@
 from domdf_python_tools.typing import String
 from domdf_python_tools.utils import convert_indents
 
-# Will be removed in 1.0
 String = String
 
 __all__ = ["Indent", "StringList"]

domdf_python_tools/typing.py

@@ -158,20 +158,7 @@ def loads(
 #  Copyright © 2000 BeOpen.com . All rights reserved.
 #  Copyright © 1995-2000 Corporation for National Research Initiatives . All rights reserved.
 #  Copyright © 1991-1995 Stichting Mathematisch Centrum . All rights reserved.
-#
-
-# if domdf_python_tools.DOCUMENTING:
-# 	WrapperDescriptorType = ''
-# 	"""
-# 	The type of methods of some built-in data types and base classes such as
-# 	:meth:`object.__init__` or :meth:`object.__lt__`.
-# 	"""
-#
-# 	MethodWrapperType = ''
-# 	MethodDescriptorType = ''
-# 	ClassMethodDescriptorType = ''
 
-# else:
 WrapperDescriptorType = type(object.__init__)
 MethodWrapperType = type(object().__str__)
 MethodDescriptorType = type(str.join)
@@ -182,6 +169,10 @@ def loads(
 class String(Protocol):
 	"""
 	:class:`~typing.Protocol` for classes that implement ``__str__``.
+
+	.. versionchanged:: 0.8.0
+
+		Moved from :mod:`domdf_python_tools.stringlist`.
 	"""
 
 	def __str__(self) -> str:
@@ -194,6 +185,8 @@ class HasHead(Protocol):
 	:class:`typing.Protocol` for classes that have a ``head``.
 
 	This includes :class:`pandas.DataFrame` and :class:`pandas.Series`.
+
+	.. versionadded:: 0.8.0
 	"""
 
 	def head(self: "FrameOrSeries", n: int = 5) -> "FrameOrSeries":