diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 6bb5a63..5c667d4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -7,13 +7,13 @@ - Add class for existing directories - Add function to format a list human-readable - Add function to assert that an object is an instance of a specific type -- Add python project documentation generator class -- Add python namespaces classes +- Add Python project documentation generator class +- Add Python namespaces classes - Add type checking for the `name` attribute at the constructor of `core.python.namespaces.PythonNamespace` - Add check whether sub-namespaces are not empty in `core.python.namespaces.PythonPackageNamespace.namespace` - Add feature to get the names of all sub-namespaces of a `core.python.namespaces.PythonPackageNamespace` - Add feature to compare `core.python.namespaces.PythonPackageNamespace` instances or `core.python.namespaces.PythonModuleNamespace` instances -- Add string representation for python namespace objects +- Add string representation for Python namespace objects - Add `PythonDocumentationGenerator` method to collect all namespaces - Add class for existing files - Add classes for Python function arguments \ No newline at end of file diff --git a/src/jcloud_docsgen/core/python/arguments.py b/src/jcloud_docsgen/core/python/arguments.py index ada2e5f..43ca7cd 100644 --- a/src/jcloud_docsgen/core/python/arguments.py +++ b/src/jcloud_docsgen/core/python/arguments.py @@ -55,7 +55,7 @@ class PythonFunctionArgumentDefault: class PythonFunctionArgument: ''' - Represents an argument of a python function. + Represents an argument of a Python function. :param name: The name of the argument. :type name: str @@ -115,10 +115,10 @@ class PythonASTArgumentsListParser: def to_argument_list(self) -> list[PythonFunctionArgument]: ''' - Converts the AST arguments list to a list of python function + Converts the AST arguments list to a list of Python function argument objects. - :return: The list of python function argument objects. + :return: The list of Python function argument objects. :rtype: list[PythonFunctionArgument] ''' diff --git a/src/jcloud_docsgen/core/python/namespaces.py b/src/jcloud_docsgen/core/python/namespaces.py index 511b511..e3ada6c 100644 --- a/src/jcloud_docsgen/core/python/namespaces.py +++ b/src/jcloud_docsgen/core/python/namespaces.py @@ -25,7 +25,7 @@ __all__ = [ class PythonNamespace: ''' - The base class for all python namespaces such as modules or packages. + The base class for all Python namespaces such as modules or packages. :param name: The name of the namespace. :type name: str @@ -45,7 +45,7 @@ PythonPackageNamespaceDictType: TypeAlias = Dict[str, Union[str, 'PythonPackageN class PythonPackageNamespace(PythonNamespace): ''' - A subclass of ``PythonNamespace`` for python package namespaces. + A subclass of ``PythonNamespace`` for Python package namespaces. :param name: The name of the namespace. :type name: str @@ -176,7 +176,7 @@ class PythonPackageNamespace(PythonNamespace): class PythonModuleNamespace(PythonNamespace): ''' - A subclass of ``PythonNamespace`` for python module namespaces. + A subclass of ``PythonNamespace`` for Python module namespaces. :param name: The name of the namespace. :type name: str