setdoc 1.2.23__tar.gz → 1.2.25__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {setdoc-1.2.23/src/setdoc.egg-info → setdoc-1.2.25}/PKG-INFO +1 -2
  2. {setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.0.rst +12 -9
  3. {setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.1.rst +12 -9
  4. {setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.2.rst +11 -8
  5. {setdoc-1.2.23 → setdoc-1.2.25}/pyproject.toml +2 -3
  6. {setdoc-1.2.23 → setdoc-1.2.25/src/setdoc.egg-info}/PKG-INFO +1 -2
  7. {setdoc-1.2.23 → setdoc-1.2.25}/LICENSE.txt +0 -0
  8. {setdoc-1.2.23 → setdoc-1.2.25}/MANIFEST.in +0 -0
  9. {setdoc-1.2.23 → setdoc-1.2.25}/README.rst +0 -0
  10. {setdoc-1.2.23 → setdoc-1.2.25}/setup.cfg +0 -0
  11. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/__init__.py +0 -0
  12. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/_utils/__init__.py +0 -0
  13. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/_utils/cfg.toml +0 -0
  14. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/core/SetDoc.py +0 -0
  15. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/core/__init__.py +0 -0
  16. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/core/basic.py +0 -0
  17. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/core/getbasicdoc.py +0 -0
  18. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/py.typed +0 -0
  19. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/tests/__init__.py +0 -0
  20. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/tests/test_core.py +0 -0
  21. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc.egg-info/SOURCES.txt +0 -0
  22. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc.egg-info/dependency_links.txt +0 -0
  23. {setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc.egg-info/top_level.txt +0 -0
{setdoc-1.2.23/src/setdoc.egg-info → setdoc-1.2.25}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: setdoc
3
- Version: 1.2.23
3
+ Version: 1.2.25
4
4
  Summary: This project helps to set the doc string.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
@@ -14,7 +14,6 @@ Classifier: Operating System :: OS Independent
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3 :: Only
17
- Classifier: Typing :: Typed
18
17
  Requires-Python: >=3.11
19
18
  Description-Content-Type: text/x-rst
20
19
  License-File: LICENSE.txt
{setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.0.rst RENAMED
@@ -6,7 +6,8 @@ This project helps to set the doc string.
6
6
  Installation
7
7
  ------------
8
8
 
9
- To install setdoc, you can use pip. Open your terminal and run:
9
+ To install ``setdoc``, you can use ``pip``.
10
+ Open your terminal and run:
10
11
 
11
12
  .. code-block:: shell
12
13
 
@@ -18,7 +19,8 @@ Features
18
19
  ``class setdoc.SetDoc(doc: Any)``
19
20
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21
 
21
- The instances of dataclass function as decorators that set the docstring of the decorated to the value of doc.
22
+ The instances of this ``dataclass`` work as decorators
23
+ that set the docstring of the decorated ``target`` to ``doc``.
22
24
 
23
25
  Usage:
24
26
 
@@ -52,27 +54,28 @@ Usage:
52
54
  ``__call__(target: Any) -> Any``
53
55
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
56
 
55
- This magic method implements calling the current instance. It sets ``target.__doc__`` to ``doc``.
57
+ This magic method implements calling the current instance.
58
+ It sets ``target.__doc__`` to ``doc``.
56
59
 
57
60
  ``doc: Any``
58
61
  ^^^^^^^^^^^^
59
62
 
60
- The value that is used for ``__doc__``.
63
+ This value that is used for ``__doc__``.
61
64
 
62
65
  ``setdoc.setdoc = setdoc.SetDoc``
63
66
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
64
67
 
65
- This module variable is alias for SetDoc included for legacy.
68
+ This module variable is alias for ``SetDoc`` included for legacy.
66
69
 
67
- ``setdoc.test() -> unittest.TextTestResult``
68
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70
+ ``setdoc.tests.test() -> unittest.TextTestResult``
71
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69
72
 
70
73
  This project can be tested through its test function.
71
74
 
72
75
  .. code-block:: python
73
76
 
74
- import setdoc
75
- setdoc.test()
77
+ import setdoc.tests
78
+ setdoc.tests.test()
76
79
 
77
80
  License
78
81
  -------
{setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.1.rst RENAMED
@@ -6,7 +6,8 @@ This project helps to set the doc string.
6
6
  Installation
7
7
  ------------
8
8
 
9
- To install setdoc, you can use pip. Open your terminal and run:
9
+ To install ``setdoc``, you can use ``pip``.
10
+ Open your terminal and run:
10
11
 
11
12
  .. code-block:: shell
12
13
 
@@ -18,7 +19,8 @@ Features
18
19
  ``class setdoc.SetDoc(doc: Any)``
19
20
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21
 
21
- The instances of dataclass function as decorators that set the docstring of the decorated to the value of doc.
22
+ The instances of this ``dataclass`` work as decorators
23
+ that set the docstring of the decorated ``target`` to ``doc``.
22
24
 
23
25
  Usage:
24
26
 
@@ -52,12 +54,13 @@ Usage:
52
54
  ``__call__(target: Any) -> Any``
53
55
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
56
 
55
- This magic method implements calling the current instance. It sets ``target.__doc__`` to ``doc``.
57
+ This magic method implements calling the current instance.
58
+ It sets ``target.__doc__`` to ``doc``.
56
59
 
57
60
  ``doc: Any``
58
61
  ^^^^^^^^^^^^
59
62
 
60
- The value that is used for ``__doc__``.
63
+ This value that is used for ``__doc__``.
61
64
 
62
65
  ``setdoc.basic(value: Any) -> Any``
63
66
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -69,17 +72,17 @@ The value that is used for ``__doc__``.
69
72
  ``setdoc.setdoc = setdoc.SetDoc``
70
73
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
71
74
 
72
- This module variable is alias for SetDoc included for legacy.
75
+ This module variable is alias for ``SetDoc`` included for legacy.
73
76
 
74
- ``setdoc.test() -> unittest.TextTestResult``
75
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
77
+ ``setdoc.tests.test() -> unittest.TextTestResult``
78
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76
79
 
77
80
  This project can be tested through its test function.
78
81
 
79
82
  .. code-block:: python
80
83
 
81
- import setdoc
82
- setdoc.test()
84
+ import setdoc.tests
85
+ setdoc.tests.test()
83
86
 
84
87
  License
85
88
  -------
{setdoc-1.2.23 → setdoc-1.2.25}/docs/v1.2.rst RENAMED
@@ -6,7 +6,8 @@ This project helps to set the doc string.
6
6
  Installation
7
7
  ------------
8
8
 
9
- To install setdoc, you can use pip. Open your terminal and run:
9
+ To install ``setdoc``, you can use ``pip``.
10
+ Open your terminal and run:
10
11
 
11
12
  .. code-block:: shell
12
13
 
@@ -18,7 +19,8 @@ Features
18
19
  ``class setdoc.SetDoc(doc: Any)``
19
20
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20
21
 
21
- The instances of dataclass function as decorators that set the docstring of the decorated to the value of doc.
22
+ The instances of this ``dataclass`` work as decorators
23
+ that set the docstring of the decorated ``target`` to ``doc``.
22
24
 
23
25
  Usage:
24
26
 
@@ -52,12 +54,13 @@ Usage:
52
54
  ``__call__(target: Any) -> Any``
53
55
  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
54
56
 
55
- This magic method implements calling the current instance. It sets ``target.__doc__`` to ``doc``.
57
+ This magic method implements calling the current instance.
58
+ It sets ``target.__doc__`` to ``doc``.
56
59
 
57
60
  ``doc: Any``
58
61
  ^^^^^^^^^^^^
59
62
 
60
- The value that is used for ``__doc__``.
63
+ This value that is used for ``__doc__``.
61
64
 
62
65
  ``setdoc.basic(value: Any) -> Any``
63
66
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -76,17 +79,17 @@ The value that is used for ``__doc__``.
76
79
  ``setdoc.setdoc = setdoc.SetDoc``
77
80
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
78
81
 
79
- This module variable is alias for SetDoc included for legacy.
82
+ This module variable is alias for ``SetDoc`` included for legacy.
80
83
 
81
- ``setdoc.test() -> unittest.TextTestResult``
84
+ ``setdoc.tests.test() -> unittest.TextTestResult``
82
85
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83
86
 
84
87
  This project can be tested through its test function.
85
88
 
86
89
  .. code-block:: python
87
90
 
88
- import setdoc
89
- setdoc.test()
91
+ import setdoc.tests
92
+ setdoc.tests.test()
90
93
 
91
94
  License
92
95
  -------
{setdoc-1.2.23 → setdoc-1.2.25}/pyproject.toml RENAMED
@@ -15,7 +15,6 @@ classifiers = [
15
15
  "Programming Language :: Python",
16
16
  "Programming Language :: Python :: 3",
17
17
  "Programming Language :: Python :: 3 :: Only",
18
- "Typing :: Typed",
19
18
  ]
20
19
  dependencies = []
21
20
  description = "This project helps to set the doc string."
@@ -27,7 +26,7 @@ license-files = [
27
26
  name = "setdoc"
28
27
  readme = "README.rst"
29
28
  requires-python = ">=3.11"
30
- version = "1.2.23"
29
+ version = "1.2.25"
31
30
 
32
31
  [project.urls]
33
32
  Download = "https://pypi.org/project/setdoc/#files"
@@ -37,7 +36,7 @@ Website = "https://setdoc.johannes-programming.online/"
37
36
 
38
37
  [tool.mypy]
39
38
  files = [
40
- "src/setdoc",
39
+ ".",
41
40
  ]
42
41
  python_version = "3.11"
43
42
  strict = false
{setdoc-1.2.23 → setdoc-1.2.25/src/setdoc.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: setdoc
3
- Version: 1.2.23
3
+ Version: 1.2.25
4
4
  Summary: This project helps to set the doc string.
5
5
  Author-email: Johannes <johannes.programming@gmail.com>
6
6
  License-Expression: MIT
@@ -14,7 +14,6 @@ Classifier: Operating System :: OS Independent
14
14
  Classifier: Programming Language :: Python
15
15
  Classifier: Programming Language :: Python :: 3
16
16
  Classifier: Programming Language :: Python :: 3 :: Only
17
- Classifier: Typing :: Typed
18
17
  Requires-Python: >=3.11
19
18
  Description-Content-Type: text/x-rst
20
19
  License-File: LICENSE.txt
{setdoc-1.2.23 → setdoc-1.2.25}/LICENSE.txt RENAMED
File without changes
{setdoc-1.2.23 → setdoc-1.2.25}/MANIFEST.in RENAMED
File without changes
{setdoc-1.2.23 → setdoc-1.2.25}/README.rst RENAMED
File without changes
{setdoc-1.2.23 → setdoc-1.2.25}/setup.cfg RENAMED
File without changes
{setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/__init__.py RENAMED
File without changes
{setdoc-1.2.23 → setdoc-1.2.25}/src/setdoc/py.typed RENAMED
File without changes