docstring-tailor 0.2.1.dev5__tar.gz → 0.2.1.dev6__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.
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/PKG-INFO +7 -2
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/README.md +6 -1
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/pyproject.toml +1 -1
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/uv.lock +1 -1
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/.gitignore +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/LICENSE +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/makefile +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/__init__.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/cli_config.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/constants.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/docstring_visitor.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/main.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/multi_line_docstring_formatter.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/__init__.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_cli.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_file_system.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_formatting.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_list_detection.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_testing.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/cases/__init__.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/cases/config_model.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/cases/formatting_cases.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/all_docstrings/all_docstrings_100.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/all_docstrings/all_docstrings_60.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/all_docstrings/all_docstrings_80.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/all_docstrings/all_docstrings_too_long.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/all_docstrings/all_docstrings_too_short.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/function_docstring_complex/function_docstring_complex_100.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/function_docstring_complex/function_docstring_complex_60.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/function_docstring_complex/function_docstring_complex_80.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_blank_lines/module_docstring_blank_lines.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_blank_lines/module_docstring_blank_lines_100.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_empty/module_docstring_empty.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_empty/module_docstring_empty_blank_lines.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_example_backticks/module_docstring_example_backticks.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_example_backticks/module_docstring_example_backticks_60.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_example_tildes/module_docstring_example_tildes.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_example_tildes/module_docstring_example_tildes_60.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_ordered_list/module_docstring_ordered_list_100.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_ordered_list/module_docstring_ordered_list_60.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_ordered_list/module_docstring_ordered_list_80.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/module_docstring_ordered_list/module_docstring_ordered_list_too_long.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/fixtures/readme_examples/readme_examples.py +0 -0
- {docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/tests/test_formatting.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: docstring-tailor
|
|
3
|
-
Version: 0.2.1.
|
|
3
|
+
Version: 0.2.1.dev6
|
|
4
4
|
Summary: Automatic formatting of Python docstrings according to PEP 257
|
|
5
5
|
Author-email: Auke Bruinsma <afbruinsma@gmail.com>
|
|
6
6
|
License: MIT License
|
|
@@ -58,12 +58,17 @@ Automatic formatting of Python docstrings according to PEP 257 and a predefined
|
|
|
58
58
|
<details>
|
|
59
59
|
<summary><b>Show demo</b></summary>
|
|
60
60
|
|
|
61
|
+
<br>
|
|
62
|
+
|
|
61
63
|
- `docstring-tailor` formats docstrings to fit a given line length, while preserving its structure throughout — For exapmle blank lines, argument indentation, continuation line alignment, and code blocks in the Examples section all remain intact.
|
|
62
64
|
- **Note**: The slider in the [Marimo notebook](https://marimo.io/) is not part of the package. It was created solely to illustrate how the output changes continuously as the line length varies.
|
|
63
65
|
|
|
64
66
|
<br>
|
|
65
67
|
|
|
66
|
-
<img src="https://
|
|
68
|
+
<img src="https://github.com/user-attachments/assets/983ae257-472d-465e-9924-9d90bca10f0d" alt="" />
|
|
69
|
+
<img src="https://i.imgur.com/2uG5HNh.gif" alt="" />
|
|
70
|
+
|
|
71
|
+
If the image does not show, click [here](https://github.com/user-attachments/assets/983ae257-472d-465e-9924-9d90bca10f0d).
|
|
67
72
|
|
|
68
73
|
</details>
|
|
69
74
|
|
|
@@ -25,12 +25,17 @@ Automatic formatting of Python docstrings according to PEP 257 and a predefined
|
|
|
25
25
|
<details>
|
|
26
26
|
<summary><b>Show demo</b></summary>
|
|
27
27
|
|
|
28
|
+
<br>
|
|
29
|
+
|
|
28
30
|
- `docstring-tailor` formats docstrings to fit a given line length, while preserving its structure throughout — For exapmle blank lines, argument indentation, continuation line alignment, and code blocks in the Examples section all remain intact.
|
|
29
31
|
- **Note**: The slider in the [Marimo notebook](https://marimo.io/) is not part of the package. It was created solely to illustrate how the output changes continuously as the line length varies.
|
|
30
32
|
|
|
31
33
|
<br>
|
|
32
34
|
|
|
33
|
-
<img src="https://
|
|
35
|
+
<img src="https://github.com/user-attachments/assets/983ae257-472d-465e-9924-9d90bca10f0d" alt="" />
|
|
36
|
+
<img src="https://i.imgur.com/2uG5HNh.gif" alt="" />
|
|
37
|
+
|
|
38
|
+
If the image does not show, click [here](https://github.com/user-attachments/assets/983ae257-472d-465e-9924-9d90bca10f0d).
|
|
34
39
|
|
|
35
40
|
</details>
|
|
36
41
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
[project]
|
|
2
2
|
name = "docstring-tailor"
|
|
3
|
-
version = "0.2.1.
|
|
3
|
+
version = "0.2.1.dev6"
|
|
4
4
|
description = "Automatic formatting of Python docstrings according to PEP 257"
|
|
5
5
|
authors = [{ name = "Auke Bruinsma", email = "afbruinsma@gmail.com" }]
|
|
6
6
|
license = { file = "LICENSE" }
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/__init__.py
RENAMED
|
File without changes
|
{docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/cli_config.py
RENAMED
|
File without changes
|
{docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/constants.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
{docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/__init__.py
RENAMED
|
File without changes
|
{docstring_tailor-0.2.1.dev5 → docstring_tailor-0.2.1.dev6}/src/docstring_tailor/utils/utils_cli.py
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|