docstring-to-text 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl
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.
- docstring_to_text/{__package_meta.py → ___package_meta.py} +1 -1
- docstring_to_text/__init__.py +6 -2
- {docstring_to_text-1.0.1.dist-info → docstring_to_text-1.0.2.dist-info}/METADATA +14 -3
- docstring_to_text-1.0.2.dist-info/RECORD +6 -0
- docstring_to_text-1.0.1.dist-info/RECORD +0 -6
- {docstring_to_text-1.0.1.dist-info → docstring_to_text-1.0.2.dist-info}/WHEEL +0 -0
- {docstring_to_text-1.0.1.dist-info → docstring_to_text-1.0.2.dist-info}/licenses/LICENSE.md +0 -0
docstring_to_text/__init__.py
CHANGED
@@ -3,13 +3,17 @@
|
|
3
3
|
A simple pip package converting docstrings into clean text (proper paragraphs and indents).
|
4
4
|
"""
|
5
5
|
|
6
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
7
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
8
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
9
|
+
|
6
10
|
import typing as _t
|
7
11
|
|
8
12
|
from inspect import cleandoc, getdoc
|
9
13
|
import re as _re
|
10
14
|
|
11
|
-
from .
|
12
|
-
from .
|
15
|
+
from .___package_meta import VERSION
|
16
|
+
from .___package_meta import VERSION as __version__
|
13
17
|
|
14
18
|
# TODO:
|
15
19
|
# - lists
|
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.4
|
2
2
|
Name: docstring-to-text
|
3
|
-
Version: 1.0.
|
3
|
+
Version: 1.0.2
|
4
4
|
Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
|
5
5
|
Project-URL: Source Code, https://github.com/Lex-DRL/Py-docstring-to-text
|
6
6
|
Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
|
@@ -13,15 +13,26 @@ Classifier: Programming Language :: Python :: 3
|
|
13
13
|
Requires-Python: >=3.7
|
14
14
|
Description-Content-Type: text/markdown
|
15
15
|
|
16
|
+
<div align="center">
|
17
|
+
|
16
18
|
# docstring-to-text
|
17
19
|
|
20
|
+
[![PyPI][pypi-shield]][pypi-url]
|
21
|
+
[![][github-release-shield]][github-release-url]
|
22
|
+
|
23
|
+
[pypi-shield]: https://img.shields.io/pypi/v/docstring-to-text?logo=pypi
|
24
|
+
[pypi-url]: https://pypi.org/p/docstring-to-text
|
25
|
+
[github-release-shield]: https://img.shields.io/github/v/release/Lex-DRL/Py-docstring-to-text?logo=github
|
26
|
+
[github-release-url]: https://github.com/Lex-DRL/Py-docstring-to-text/releases/latest
|
27
|
+
</div>
|
28
|
+
|
18
29
|
A simple pip package converting docstrings into clean text (proper paragraphs and indents).
|
19
30
|
|
20
31
|
For example, here's a class docstring:
|
21
32
|
```python
|
22
33
|
class MyClass:
|
23
34
|
"""
|
24
|
-
|
35
|
+
This is a class docstring.
|
25
36
|
|
26
37
|
|
27
38
|
It has sphinx-like paragraphs, which can
|
@@ -60,7 +71,7 @@ clean_text = format_object_docstring(MyClass)
|
|
60
71
|
|
61
72
|
Then, the resulting string would be:
|
62
73
|
```text
|
63
|
-
|
74
|
+
This is a class docstring.
|
64
75
|
|
65
76
|
It has sphinx-like paragraphs, which can span multiple lines. Any modern IDE would display them as a single line, that wraps the given width.
|
66
77
|
You can't just remove all the new lines in the entire string, because you want to preserve paragraphs themselves.
|
@@ -0,0 +1,6 @@
|
|
1
|
+
docstring_to_text/___package_meta.py,sha256=FUBADIvPxuLvXBzbXbL6C1ybLYS24VOYEd_RcSq76tQ,37
|
2
|
+
docstring_to_text/__init__.py,sha256=BDcfU7T33sckZzEZFZn2GPezDtb9fkv1A2uo2mPYZas,5000
|
3
|
+
docstring_to_text-1.0.2.dist-info/METADATA,sha256=x73dRgwjxhTFwd8D-znLYo7mYL61OdF6UwG9H0ky7VI,2748
|
4
|
+
docstring_to_text-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
5
|
+
docstring_to_text-1.0.2.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
|
6
|
+
docstring_to_text-1.0.2.dist-info/RECORD,,
|
@@ -1,6 +0,0 @@
|
|
1
|
-
docstring_to_text/__init__.py,sha256=tkoGbf8ZJv70Nf2osZSn4DoHwSZKK2nvRREpvaVHank,4798
|
2
|
-
docstring_to_text/__package_meta.py,sha256=AkzYkNZ1txGq77pbjfo4hVXLrvLpeJOHmfoOc0AZgiY,37
|
3
|
-
docstring_to_text-1.0.1.dist-info/METADATA,sha256=JrCksCfeZ8SLMwzZ9GlM-olZCQWLfHY41q6JKHUp5ME,2297
|
4
|
-
docstring_to_text-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
5
|
-
docstring_to_text-1.0.1.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
|
6
|
-
docstring_to_text-1.0.1.dist-info/RECORD,,
|
File without changes
|
File without changes
|