format-docstring 0.2.7__tar.gz → 0.4.0__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.
- {format_docstring-0.2.7 → format_docstring-0.4.0}/.gitignore +2 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/.pre-commit-config.yaml +19 -6
- {format_docstring-0.2.7 → format_docstring-0.4.0}/CHANGELOG.md +37 -0
- format_docstring-0.4.0/PKG-INFO +693 -0
- format_docstring-0.4.0/README.md +661 -0
- format_docstring-0.4.0/format_docstring/config.py +427 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/docstring_rewriter.py +196 -15
- format_docstring-0.4.0/format_docstring/line_wrap_google.py +2183 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/line_wrap_numpy.py +425 -130
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/line_wrap_utils.py +587 -14
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/main_jupyter.py +57 -9
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/main_py.py +56 -12
- format_docstring-0.4.0/format_docstring/section_utils.py +177 -0
- format_docstring-0.4.0/format_docstring.egg-info/PKG-INFO +693 -0
- format_docstring-0.4.0/format_docstring.egg-info/SOURCES.txt +269 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/muff.toml +1 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/pyproject.toml +7 -11
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/helpers.py +1 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_config.py +247 -4
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_defaults_false.txt +133 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_types_and_defaults_false.txt +83 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_types_and_defaults_true.txt +84 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_return_and_yield_types_false.txt +60 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_defaults_false.txt +155 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_types_and_defaults_false.txt +113 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_types_and_defaults_true.txt +113 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/README.md +10 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/arg_name_is_default.txt +37 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/class_attribute_type_comment_defaults.txt +34 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/colon_spacing_fix.txt +52 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/contents_that_are_not_wrapped.txt +99 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_after_args.txt +27 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_after_doctest.txt +25 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_before_args.txt +26 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/default_value_standardization.txt +75 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/doctest_output_lines_are_preserved.txt +26 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/empty_lines_are_respected.txt +79 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/examples_plain_code_after_doctest.txt +25 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/examples_section.txt +93 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/existing_linebreaks_should_not_be_respected.txt +26 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/fix_rst_backticks.txt +152 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/four_level_nested_classes.txt +95 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_four_levels_16_spaces_width_10.txt +55 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_misaligned_all.txt +68 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_two_levels_8_spaces.txt +20 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/keyword_args_section.txt +22 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/line_length_2.txt +56 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/literal_block_backticks_are_preserved.txt +18 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/literal_block_blank_lines_backticks_are_preserved.txt +26 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/module_docstring_indent_zero_is_not_inferred.txt +14 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/module_level_docstring.txt +18 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/new_lines_before_and_after.txt +142 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/no_format_docstring_comment.txt +52 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/no_terminal_whitespace_only_line.txt +19 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/non_ascii_single_line_length_boundary.txt +11 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/param_signature_without_type.txt +29 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/parameters_returns_raises_wrapping.txt +58 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/plain_examples_code_is_preserved.txt +24 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/rST_cross_reference.txt +77 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_bare_type_with_description_sync.txt +22 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_colon_description_sync.txt +62 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_description_without_type_sync.txt +20 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_signature_and_description.txt +22 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_yields_type_like_description_sync.txt +45 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/rst_code_block_backticks_are_preserved.txt +27 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/section_headings_with_colons.txt +48 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/section_title_fixed.txt +48 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/sections_notes_examples.txt +64 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_dont_sync_raises.txt +38 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_line_is_not_wrapped.txt +22 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_class_docstrings.txt +168 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_parameters.txt +204 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_returns.txt +170 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_yields.txt +126 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/single_line_backtick_expansion_respects_line_length.txt +13 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/single_line_docstring.txt +76 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/texts_are_rewrapped.txt +126 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/tilde_code_fence_is_preserved.txt +28 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/variadic_signature_without_colon.txt +50 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/very_long_unbreakable_word.txt +19 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/google/yields_iterator_item_type_sync.txt +30 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/README.md +9 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/class_attribute_type_comment_defaults.txt +43 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_after_args.txt +34 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_after_doctest.txt +31 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_before_args.txt +33 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/doctest_output_lines_are_preserved.txt +29 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/examples_plain_code_after_doctest.txt +27 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/keyword_args_section.txt +29 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/literal_block_backticks_are_preserved.txt +19 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/literal_block_blank_lines_backticks_are_preserved.txt +27 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/module_docstring_indent_zero_is_not_inferred.txt +14 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/no_terminal_whitespace_only_line.txt +21 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/non_ascii_docstrings.txt +89 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/non_ascii_single_line_length_boundary.txt +11 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/plain_examples_code_is_preserved.txt +27 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_bare_type_with_description_sync.txt +26 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_colon_description_sync.txt +28 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_description_without_type_sync.txt +24 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_yields_type_like_description_sync.txt +53 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/rst_code_block_backticks_are_preserved.txt +27 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/sections_notes_examples.txt +1 -2
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_class_docstrings.txt +5 -1
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_yields.txt +5 -3
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/single_line_backtick_expansion_respects_line_length.txt +13 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/tilde_code_fence_is_preserved.txt +35 -0
- format_docstring-0.4.0/tests/test_data/end_to_end/numpy/yields_iterator_item_type_sync.txt +35 -0
- format_docstring-0.4.0/tests/test_data/integration_test/google/after.ipynb +91 -0
- format_docstring-0.4.0/tests/test_data/integration_test/google/after.py +34 -0
- format_docstring-0.4.0/tests/test_data/integration_test/google/after_50.ipynb +99 -0
- format_docstring-0.4.0/tests/test_data/integration_test/google/after_50.py +42 -0
- format_docstring-0.4.0/tests/test_data/integration_test/google/before.ipynb +78 -0
- format_docstring-0.4.0/tests/test_data/integration_test/numpy/before.py +24 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/README.md +24 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/arg_description_starts_with_bulleted_list.txt +14 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/arg_description_starts_with_table.txt +20 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/colon_spacing_fix.txt +21 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/contents_that_are_not_wrapped.txt +88 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_after_args.txt +20 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_after_doctest.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_before_args.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/default_value_standardization.txt +26 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_backticks_are_preserved.txt +15 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_lines_are_preserved.txt +15 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_section_headers_are_preserved.txt +41 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_plain_output_is_preserved.txt +15 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/empty_lines_are_respected.txt +62 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_leading_comment_is_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_plain_code_after_doctest.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_plain_output_after_code_is_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_section.txt +44 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/existing_linebreaks_should_not_be_respected.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/fenced_code_backticks_are_preserved.txt +13 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/fix_rst_backticks.txt +83 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/indent_two_levels_8_spaces.txt +13 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/label_like_prose_in_notes.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_backticks_are_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_blank_lines_backticks_are_preserved.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_marker_double_colon_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/module_level_docstring.txt +12 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/no_terminal_whitespace_only_line.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/non_ascii_docstrings.txt +69 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/param_signature_without_type.txt +21 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/parameters_returns_raises_wrapping.txt +45 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/plain_examples_code_is_preserved.txt +14 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/returns_signature_and_description.txt +20 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/rst_code_block_backticks_are_preserved.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/section_headings_with_colons.txt +40 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/section_title_fixed.txt +40 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/sections_notes_examples.txt +53 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/signature_line_is_not_wrapped.txt +14 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/texts_are_rewrapped.txt +113 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/tilde_code_fence_is_preserved.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/variadic_signature_without_colon.txt +27 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/google/very_long_unbreakable_word.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/README.md +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/arg_description_starts_with_bulleted_list.txt +16 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/arg_description_starts_with_table.txt +22 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_after_args.txt +26 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_after_doctest.txt +23 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_before_args.txt +25 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_backticks_are_preserved.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_lines_are_preserved.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_section_headers_are_preserved.txt +31 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_plain_output_is_preserved.txt +17 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_leading_comment_is_preserved.txt +13 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_plain_code_after_doctest.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_plain_output_after_code_is_preserved.txt +13 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/fenced_code_backticks_are_preserved.txt +15 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/indent_four_levels_16_spaces_width_10.txt +46 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/label_like_prose_in_notes.txt +13 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/line_length_2.txt +49 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_backticks_are_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_blank_lines_backticks_are_preserved.txt +19 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_marker_double_colon_preserved.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/no_terminal_whitespace_only_line.txt +11 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/plain_examples_code_is_preserved.txt +16 -0
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/rst_code_block_backticks_are_preserved.txt +19 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/sections_notes_examples.txt +1 -2
- format_docstring-0.4.0/tests/test_data/line_wrap/numpy/tilde_code_fence_is_preserved.txt +23 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_docstring_rewriter.py +281 -10
- format_docstring-0.4.0/tests/test_google_fixture_inventory.py +49 -0
- format_docstring-0.4.0/tests/test_line_wrap_google.py +244 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_line_wrap_numpy.py +150 -14
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_line_wrap_utils.py +593 -26
- format_docstring-0.4.0/tests/test_main_jupyter.py +344 -0
- format_docstring-0.4.0/tests/test_main_py.py +286 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_playground.py +2 -2
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tox.ini +10 -10
- format_docstring-0.2.7/PKG-INFO +0 -494
- format_docstring-0.2.7/README.md +0 -462
- format_docstring-0.2.7/format_docstring/config.py +0 -212
- format_docstring-0.2.7/format_docstring/line_wrap_google.py +0 -15
- format_docstring-0.2.7/format_docstring.egg-info/PKG-INFO +0 -494
- format_docstring-0.2.7/format_docstring.egg-info/SOURCES.txt +0 -112
- format_docstring-0.2.7/tests/test_data/end_to_end/numpy/README.md +0 -2
- format_docstring-0.2.7/tests/test_data/line_wrap/numpy/README.md +0 -1
- format_docstring-0.2.7/tests/test_line_wrap_google.py +0 -0
- format_docstring-0.2.7/tests/test_main_jupyter.py +0 -90
- format_docstring-0.2.7/tests/test_main_py.py +0 -88
- {format_docstring-0.2.7 → format_docstring-0.4.0}/.github/workflows/python-package.yml +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/.github/workflows/python-publish.yml +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/.pre-commit-hooks.yaml +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/AGENTS.md +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/LICENSE +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/__init__.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/base_fixer.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/dependency_links.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/entry_points.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/requires.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/top_level.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/requirements.dev +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/setup.cfg +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/__init__.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_base_fixer.py +0 -0
- {format_docstring-0.2.7/tests/test_data/end_to_end/numpy → format_docstring-0.4.0/tests/test_data/end_to_end/google}/non_ascii_docstrings.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/arg_name_is_default.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/colon_spacing_fix.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/contents_that_are_not_wrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/default_value_standardization.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/empty_lines_are_respected.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/examples_section.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/existing_linebreaks_should_not_be_respected.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/fix_rst_backticks.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/four_level_nested_classes.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/indent_four_levels_16_spaces_width_10.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/indent_misaligned_all.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/indent_two_levels_8_spaces.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/line_length_2.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines_one_dash.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines_two_dashes.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/module_level_docstring.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/new_lines_before_and_after.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/no_format_docstring_comment.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/param_signature_without_type.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/parameters_returns_raises_wrapping.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/rST_cross_reference.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/returns_signature_and_description.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/section_headings_with_colons.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/section_title_fixed.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_dont_sync_raises.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_line_is_not_wrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_parameters.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_returns.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/single_line_docstring.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/texts_are_rewrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/variadic_signature_without_colon.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/very_long_unbreakable_word.txt +0 -0
- {format_docstring-0.2.7/tests/test_data/integration_test/numpy → format_docstring-0.4.0/tests/test_data/integration_test/google}/before.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after.ipynb +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after_50.ipynb +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after_50.py +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/before.ipynb +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/jupyter/before.ipynb +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/jupyter/verbose_before.ipynb +0 -0
- {format_docstring-0.2.7/tests/test_data/line_wrap/numpy → format_docstring-0.4.0/tests/test_data/line_wrap/google}/indent_four_levels_16_spaces_width_10.txt +0 -0
- {format_docstring-0.2.7/tests/test_data/line_wrap/numpy → format_docstring-0.4.0/tests/test_data/line_wrap/google}/line_length_2.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/colon_spacing_fix.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/contents_that_are_not_wrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/default_value_standardization.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/empty_lines_are_respected.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/examples_section.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/existing_linebreaks_should_not_be_respected.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/fix_rst_backticks.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/indent_two_levels_8_spaces.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines_one_dash.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines_two_dashes.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/module_level_docstring.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/non_ascii_docstrings.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/param_signature_without_type.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/parameters_returns_raises_wrapping.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/returns_signature_and_description.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/section_headings_with_colons.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/section_title_fixed.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/signature_line_is_not_wrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/texts_are_rewrapped.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/variadic_signature_without_colon.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/very_long_unbreakable_word.txt +0 -0
- {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/playground.py +0 -0
|
@@ -17,7 +17,7 @@ repos:
|
|
|
17
17
|
exclude: ^tests/helpers\.py$
|
|
18
18
|
- id: check-merge-conflict
|
|
19
19
|
- repo: https://github.com/jsh9/muff-pre-commit
|
|
20
|
-
rev: 0.
|
|
20
|
+
rev: 0.15.20
|
|
21
21
|
hooks:
|
|
22
22
|
- id: muff-format
|
|
23
23
|
args: [--config, muff.toml]
|
|
@@ -27,11 +27,11 @@ repos:
|
|
|
27
27
|
- id: blank-line-after-blocks
|
|
28
28
|
- id: blank-line-after-blocks-jupyter
|
|
29
29
|
- repo: https://github.com/lyz-code/yamlfix
|
|
30
|
-
rev: 1.
|
|
30
|
+
rev: 1.19.1
|
|
31
31
|
hooks:
|
|
32
32
|
- id: yamlfix
|
|
33
33
|
- repo: https://github.com/pappasam/toml-sort
|
|
34
|
-
rev: v0.24.
|
|
34
|
+
rev: v0.24.4
|
|
35
35
|
hooks:
|
|
36
36
|
- id: toml-sort-fix
|
|
37
37
|
args:
|
|
@@ -42,7 +42,7 @@ repos:
|
|
|
42
42
|
- --trailing-comma-inline-array
|
|
43
43
|
- --sort-inline-arrays
|
|
44
44
|
- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
|
|
45
|
-
rev: v2.
|
|
45
|
+
rev: v2.16.0
|
|
46
46
|
hooks:
|
|
47
47
|
- id: pretty-format-ini
|
|
48
48
|
args: [--autofix]
|
|
@@ -63,15 +63,28 @@ repos:
|
|
|
63
63
|
- --no-sort-keys
|
|
64
64
|
- --no-eof-newline
|
|
65
65
|
- repo: https://github.com/jsh9/markdown-toc-creator
|
|
66
|
-
rev: 0.1.
|
|
66
|
+
rev: 0.1.3
|
|
67
67
|
hooks:
|
|
68
68
|
- id: markdown-toc-creator
|
|
69
69
|
exclude: ^AGENTS\.md$|^CHANGELOG\.md$
|
|
70
70
|
- repo: https://github.com/jsh9/markdown-heading-numbering
|
|
71
|
-
rev: 0.1.
|
|
71
|
+
rev: 0.1.1
|
|
72
72
|
hooks:
|
|
73
73
|
- id: markdown-heading-numbering
|
|
74
74
|
exclude: ^CHANGELOG\.md$
|
|
75
|
+
- repo: https://github.com/jsh9/pre-commit-tox-version-sync
|
|
76
|
+
rev: 0.1.1
|
|
77
|
+
hooks:
|
|
78
|
+
- id: sync-precommit-tox-versions
|
|
79
|
+
args:
|
|
80
|
+
- --pre-commit-repo
|
|
81
|
+
- https://github.com/jsh9/muff-pre-commit
|
|
82
|
+
- --tox-env
|
|
83
|
+
- muff-lint
|
|
84
|
+
- --tox-env
|
|
85
|
+
- muff-format
|
|
86
|
+
- --tox-dep
|
|
87
|
+
- muff
|
|
75
88
|
- repo: local
|
|
76
89
|
hooks:
|
|
77
90
|
- id: format-docstring
|
|
@@ -6,6 +6,43 @@ The format is based on
|
|
|
6
6
|
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
|
|
7
7
|
adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
8
8
|
|
|
9
|
+
## [0.4.0] - 2026-06-29
|
|
10
|
+
|
|
11
|
+
- Added
|
|
12
|
+
- CLI and `pyproject.toml` options to control whether argument types,
|
|
13
|
+
argument defaults, and Google return/yield types are included in docstring
|
|
14
|
+
signature lines for Python files and Jupyter notebooks.
|
|
15
|
+
- Fixed
|
|
16
|
+
- Google-style argument signature synchronization preserves existing
|
|
17
|
+
`required` metadata when source annotations replace stale docstring type
|
|
18
|
+
text.
|
|
19
|
+
- Full diff
|
|
20
|
+
- https://github.com/jsh9/format-docstring/compare/0.3.0...0.4.0
|
|
21
|
+
|
|
22
|
+
## [0.3.0] - 2026-06-19
|
|
23
|
+
|
|
24
|
+
- Added
|
|
25
|
+
- Google-style docstring formatting for Python files and Jupyter notebooks
|
|
26
|
+
via `--docstring-style google` or `docstring_style = "google"` under
|
|
27
|
+
`[tool.format_docstring]`
|
|
28
|
+
- Google `Args:`, `Attributes:`, `Returns:`, and `Yields:` signature
|
|
29
|
+
synchronization from source annotations, defaults, class attributes, and
|
|
30
|
+
generator yield annotations
|
|
31
|
+
- Fixture coverage for Google line wrapping, end-to-end rewrites, notebook
|
|
32
|
+
rewrites, protected blocks, custom sections, and signature synchronization
|
|
33
|
+
- Changed
|
|
34
|
+
- Shared section and protected-block parsing so NumPy and Google formatting
|
|
35
|
+
preserve doctests, Python example code, fenced code, rST code blocks,
|
|
36
|
+
literal blocks, tables, and bullet lists more consistently
|
|
37
|
+
- README examples and configuration docs now describe NumPy and Google
|
|
38
|
+
behavior separately
|
|
39
|
+
- Development type checking now uses `ty` instead of `mypy`
|
|
40
|
+
- Fixed
|
|
41
|
+
- CLI config discovery now applies `pyproject.toml` settings found by walking
|
|
42
|
+
up from the target file or directory
|
|
43
|
+
- Full diff
|
|
44
|
+
- https://github.com/jsh9/format-docstring/compare/0.2.7...0.3.0
|
|
45
|
+
|
|
9
46
|
## [0.2.7] - 2025-12-04
|
|
10
47
|
|
|
11
48
|
- Fixed
|