setdoc 1.2.26__tar.gz → 1.3.1__tar.gz

{setdoc-1.2.26/src/setdoc.egg-info → setdoc-1.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.2.26
+Version: 1.3.1
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT
@@ -14,6 +14,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt

setdoc-1.3.1/docs/v1.3.rst

@@ -0,0 +1,124 @@
+Introduction
+------------
+
+This project helps to set the doc string.
+
+Installation
+------------
+
+To install ``setdoc``, you can use ``pip``.
+Open your terminal and run:
+
+.. code-block:: shell
+
+    pip install setdoc
+
+Typing
+------
+
+The typing conforms (not strictly) to ``mypy``.
+
+.. container:: versionadded
+
+    **Added in version 1.3.**
+
+Features
+--------
+
+``class setdoc.SetDoc(doc: Any)``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The instances of this ``dataclass`` work as decorators
+that set the docstring of the decorated ``target`` to ``doc``.
+
+Usage:
+
+.. code-block:: python
+
+    from typing import *
+    from setdoc import SetDoc
+
+    # Create a setdoc instance with the desired docstring
+    doc_updater: SetDoc
+    doc_updater = SetDoc("This function adds two numbers.")
+
+    # Apply it to a target function
+    @doc_updater
+    def add(a: int, b: int) -> int:
+        return a + b
+
+    # The function now has an updated docstring
+    print(add.__doc__)
+    # Output: This function adds two numbers.
+
+    # Apply it directly to another target function
+    @SetDoc("This function multiplies two numbers.")
+    def mul(a: int, b: int) -> int:
+        return a * b
+
+    # The function now has an updated docstring
+    print(mul.__doc__)
+    # Output: This function multiplies two numbers.
+
+``__call__(target: Any) -> Any``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This magic method implements calling the current instance.
+It sets ``target.__doc__`` to ``doc``.
+
+``doc: Any``
+^^^^^^^^^^^^
+
+This value that is used for ``__doc__``.
+
+``setdoc.basic(value: Any) -> Any``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container:: versionadded
+
+    **Added in version 1.1.**
+
+``setdoc.getbasicdoc(name: str) -> str``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. container:: versionadded
+
+    **Added in version 1.2.**
+
+``setdoc.setdoc = setdoc.SetDoc``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This module variable is alias for ``SetDoc`` included for legacy.
+
+``setdoc.tests.test() -> unittest.TextTestResult``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This project can be tested through its test function.
+
+.. code-block:: python
+
+    import setdoc.tests
+    setdoc.tests.test()
+
+License
+-------
+
+This project is licensed under the MIT License.
+
+Links
+-----
+
+- Download: https://pypi.org/project/setdoc/#files
+- Index: https://pypi.org/project/setdoc/
+- Source: https://github.com/johannes-programming/setdoc/
+- Website: https://setdoc.johannes-programming.online/
+
+Impressum
+---------
+
+**Johannes Programming**
+
+- Name: Johannes
+- Email: johannes.programming@gmail.com
+- Homepage: https://www.johannes-programming.online/
+- Gravatar: https://www.johannes-programming.fyi/

{setdoc-1.2.26 → setdoc-1.3.1}/pyproject.toml

@@ -15,6 +15,7 @@ classifiers = [
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3 :: Only",
+    "Typing :: Typed",
 ]
 dependencies = []
 description = "This project helps to set the doc string."
@@ -26,7 +27,7 @@ license-files = [
 name = "setdoc"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "1.2.26"
+version = "1.3.1"
 
 [project.urls]
 Download = "https://pypi.org/project/setdoc/#files"

{setdoc-1.2.26 → setdoc-1.3.1/src/setdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: setdoc
-Version: 1.2.26
+Version: 1.3.1
 Summary: This project helps to set the doc string.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT
@@ -14,6 +14,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Description-Content-Type: text/x-rst
 License-File: LICENSE.txt

{setdoc-1.2.26 → setdoc-1.3.1}/src/setdoc.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ setup.cfg
 docs/v1.0.rst
 docs/v1.1.rst
 docs/v1.2.rst
+docs/v1.3.rst
 src/setdoc/__init__.py
 src/setdoc/py.typed
 src/setdoc.egg-info/PKG-INFO