docstring-to-text 1.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

docstring_to_text/__init__.py

@@ -11,6 +11,21 @@ import re as _re
 from .__package_meta import VERSION
 from .__package_meta import VERSION as __version__
 
+# TODO:
+# - lists
+#   formatted with indents
+#   in all lines except for the first one
+#
+# Also...
+#   - preserve indents
+#   - of the entire list
+#
+# And...
+#   - ensure
+#     that
+#     - it all works
+#       with nested lists
+
 
 _re_indent_match = _re.compile(r"(\t*)( +)(\t*)(.*?)$").match
 _re_tab_indent_match = _re.compile(r"(\t+)(.*?)$").match

docstring_to_text/__package_meta.py

@@ -1,3 +1,3 @@
 # encoding: utf-8
 
-VERSION = "1.0.0"
+VERSION = "1.0.1"

{docstring_to_text-1.0.0.dist-info → docstring_to_text-1.0.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-to-text
-Version: 1.0.0
+Version: 1.0.1
 Summary: A simple pip package converting docstrings into clean text (proper paragraphs and indents)
 Project-URL: Source Code, https://github.com/Lex-DRL/Py-docstring-to-text
 Project-URL: Issues, https://github.com/Lex-DRL/Py-docstring-to-text/issues
@@ -34,12 +34,14 @@ class MyClass:
   to preserve paragraphs themselves.
   
   Also, when it comes to lists:
-  - You probably want to separate items
+    - You probably want to separate items
     with new lines.
-  - However, you don't want to preserve
+    - However, you don't want to preserve
     lines inside each item.
-  * And you might need various bullet
-    characters.
+  
+  And...
+  * ... you might need various bullet
+  characters.
   • Including unicode ones.
   
   And don't forget that the list still needs
@@ -65,7 +67,8 @@ You can't just remove all the new lines in the entire string, because you want t
 Also, when it comes to lists:
 - You probably want to separate items with new lines.
 - However, you don't want to preserve lines inside each item.
-* And you might need various bullet characters.
+And...
+* ... you might need various bullet characters.
 • Including unicode ones.
 And don't forget that the list still needs to be separated from the following text.
 ```

docstring_to_text-1.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+docstring_to_text/__init__.py,sha256=tkoGbf8ZJv70Nf2osZSn4DoHwSZKK2nvRREpvaVHank,4798
+docstring_to_text/__package_meta.py,sha256=AkzYkNZ1txGq77pbjfo4hVXLrvLpeJOHmfoOc0AZgiY,37
+docstring_to_text-1.0.1.dist-info/METADATA,sha256=JrCksCfeZ8SLMwzZ9GlM-olZCQWLfHY41q6JKHUp5ME,2297
+docstring_to_text-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+docstring_to_text-1.0.1.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
+docstring_to_text-1.0.1.dist-info/RECORD,,

docstring_to_text-1.0.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-docstring_to_text/__init__.py,sha256=2MJG9bHcgcFFLi5inNMPrX5jK0d5HVyQbQa7UCV1qK4,4568
-docstring_to_text/__package_meta.py,sha256=oj-ODmFPhzd3LWRxF98TKGvRXngna0diWblm3bsLhKQ,37
-docstring_to_text-1.0.0.dist-info/METADATA,sha256=Bl4mySaWiEnpNqTKnsP4m80J0x6KFzdrsHqVCG4Ou7Q,2276
-docstring_to_text-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-docstring_to_text-1.0.0.dist-info/licenses/LICENSE.md,sha256=quBniO1Sk1aqYUzwRO5adu_nnqOKV_4UVU4JVfnWiS0,15373
-docstring_to_text-1.0.0.dist-info/RECORD,,