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.
Files changed (282) hide show
  1. {format_docstring-0.2.7 → format_docstring-0.4.0}/.gitignore +2 -0
  2. {format_docstring-0.2.7 → format_docstring-0.4.0}/.pre-commit-config.yaml +19 -6
  3. {format_docstring-0.2.7 → format_docstring-0.4.0}/CHANGELOG.md +37 -0
  4. format_docstring-0.4.0/PKG-INFO +693 -0
  5. format_docstring-0.4.0/README.md +661 -0
  6. format_docstring-0.4.0/format_docstring/config.py +427 -0
  7. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/docstring_rewriter.py +196 -15
  8. format_docstring-0.4.0/format_docstring/line_wrap_google.py +2183 -0
  9. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/line_wrap_numpy.py +425 -130
  10. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/line_wrap_utils.py +587 -14
  11. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/main_jupyter.py +57 -9
  12. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/main_py.py +56 -12
  13. format_docstring-0.4.0/format_docstring/section_utils.py +177 -0
  14. format_docstring-0.4.0/format_docstring.egg-info/PKG-INFO +693 -0
  15. format_docstring-0.4.0/format_docstring.egg-info/SOURCES.txt +269 -0
  16. {format_docstring-0.2.7 → format_docstring-0.4.0}/muff.toml +1 -0
  17. {format_docstring-0.2.7 → format_docstring-0.4.0}/pyproject.toml +7 -11
  18. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/helpers.py +1 -0
  19. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_config.py +247 -4
  20. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_defaults_false.txt +133 -0
  21. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_types_and_defaults_false.txt +83 -0
  22. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_arg_types_and_defaults_true.txt +84 -0
  23. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/google/include_return_and_yield_types_false.txt +60 -0
  24. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_defaults_false.txt +155 -0
  25. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_types_and_defaults_false.txt +113 -0
  26. format_docstring-0.4.0/tests/test_data/end_to_end/cli_options/numpy/include_arg_types_and_defaults_true.txt +113 -0
  27. format_docstring-0.4.0/tests/test_data/end_to_end/google/README.md +10 -0
  28. format_docstring-0.4.0/tests/test_data/end_to_end/google/arg_name_is_default.txt +37 -0
  29. format_docstring-0.4.0/tests/test_data/end_to_end/google/class_attribute_type_comment_defaults.txt +34 -0
  30. format_docstring-0.4.0/tests/test_data/end_to_end/google/colon_spacing_fix.txt +52 -0
  31. format_docstring-0.4.0/tests/test_data/end_to_end/google/contents_that_are_not_wrapped.txt +99 -0
  32. format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_after_args.txt +27 -0
  33. format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_after_doctest.txt +25 -0
  34. format_docstring-0.4.0/tests/test_data/end_to_end/google/custom_section_before_args.txt +26 -0
  35. format_docstring-0.4.0/tests/test_data/end_to_end/google/default_value_standardization.txt +75 -0
  36. format_docstring-0.4.0/tests/test_data/end_to_end/google/doctest_output_lines_are_preserved.txt +26 -0
  37. format_docstring-0.4.0/tests/test_data/end_to_end/google/empty_lines_are_respected.txt +79 -0
  38. format_docstring-0.4.0/tests/test_data/end_to_end/google/examples_plain_code_after_doctest.txt +25 -0
  39. format_docstring-0.4.0/tests/test_data/end_to_end/google/examples_section.txt +93 -0
  40. format_docstring-0.4.0/tests/test_data/end_to_end/google/existing_linebreaks_should_not_be_respected.txt +26 -0
  41. format_docstring-0.4.0/tests/test_data/end_to_end/google/fix_rst_backticks.txt +152 -0
  42. format_docstring-0.4.0/tests/test_data/end_to_end/google/four_level_nested_classes.txt +95 -0
  43. format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_four_levels_16_spaces_width_10.txt +55 -0
  44. format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_misaligned_all.txt +68 -0
  45. format_docstring-0.4.0/tests/test_data/end_to_end/google/indent_two_levels_8_spaces.txt +20 -0
  46. format_docstring-0.4.0/tests/test_data/end_to_end/google/keyword_args_section.txt +22 -0
  47. format_docstring-0.4.0/tests/test_data/end_to_end/google/line_length_2.txt +56 -0
  48. format_docstring-0.4.0/tests/test_data/end_to_end/google/literal_block_backticks_are_preserved.txt +18 -0
  49. format_docstring-0.4.0/tests/test_data/end_to_end/google/literal_block_blank_lines_backticks_are_preserved.txt +26 -0
  50. format_docstring-0.4.0/tests/test_data/end_to_end/google/module_docstring_indent_zero_is_not_inferred.txt +14 -0
  51. format_docstring-0.4.0/tests/test_data/end_to_end/google/module_level_docstring.txt +18 -0
  52. format_docstring-0.4.0/tests/test_data/end_to_end/google/new_lines_before_and_after.txt +142 -0
  53. format_docstring-0.4.0/tests/test_data/end_to_end/google/no_format_docstring_comment.txt +52 -0
  54. format_docstring-0.4.0/tests/test_data/end_to_end/google/no_terminal_whitespace_only_line.txt +19 -0
  55. format_docstring-0.4.0/tests/test_data/end_to_end/google/non_ascii_single_line_length_boundary.txt +11 -0
  56. format_docstring-0.4.0/tests/test_data/end_to_end/google/param_signature_without_type.txt +29 -0
  57. format_docstring-0.4.0/tests/test_data/end_to_end/google/parameters_returns_raises_wrapping.txt +58 -0
  58. format_docstring-0.4.0/tests/test_data/end_to_end/google/plain_examples_code_is_preserved.txt +24 -0
  59. format_docstring-0.4.0/tests/test_data/end_to_end/google/rST_cross_reference.txt +77 -0
  60. format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_bare_type_with_description_sync.txt +22 -0
  61. format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_colon_description_sync.txt +62 -0
  62. format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_description_without_type_sync.txt +20 -0
  63. format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_signature_and_description.txt +22 -0
  64. format_docstring-0.4.0/tests/test_data/end_to_end/google/returns_yields_type_like_description_sync.txt +45 -0
  65. format_docstring-0.4.0/tests/test_data/end_to_end/google/rst_code_block_backticks_are_preserved.txt +27 -0
  66. format_docstring-0.4.0/tests/test_data/end_to_end/google/section_headings_with_colons.txt +48 -0
  67. format_docstring-0.4.0/tests/test_data/end_to_end/google/section_title_fixed.txt +48 -0
  68. format_docstring-0.4.0/tests/test_data/end_to_end/google/sections_notes_examples.txt +64 -0
  69. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_dont_sync_raises.txt +38 -0
  70. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_line_is_not_wrapped.txt +22 -0
  71. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_class_docstrings.txt +168 -0
  72. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_parameters.txt +204 -0
  73. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_returns.txt +170 -0
  74. format_docstring-0.4.0/tests/test_data/end_to_end/google/signature_sync_yields.txt +126 -0
  75. format_docstring-0.4.0/tests/test_data/end_to_end/google/single_line_backtick_expansion_respects_line_length.txt +13 -0
  76. format_docstring-0.4.0/tests/test_data/end_to_end/google/single_line_docstring.txt +76 -0
  77. format_docstring-0.4.0/tests/test_data/end_to_end/google/texts_are_rewrapped.txt +126 -0
  78. format_docstring-0.4.0/tests/test_data/end_to_end/google/tilde_code_fence_is_preserved.txt +28 -0
  79. format_docstring-0.4.0/tests/test_data/end_to_end/google/variadic_signature_without_colon.txt +50 -0
  80. format_docstring-0.4.0/tests/test_data/end_to_end/google/very_long_unbreakable_word.txt +19 -0
  81. format_docstring-0.4.0/tests/test_data/end_to_end/google/yields_iterator_item_type_sync.txt +30 -0
  82. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/README.md +9 -0
  83. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/class_attribute_type_comment_defaults.txt +43 -0
  84. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_after_args.txt +34 -0
  85. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_after_doctest.txt +31 -0
  86. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/custom_section_before_args.txt +33 -0
  87. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/doctest_output_lines_are_preserved.txt +29 -0
  88. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/examples_plain_code_after_doctest.txt +27 -0
  89. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/keyword_args_section.txt +29 -0
  90. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/literal_block_backticks_are_preserved.txt +19 -0
  91. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/literal_block_blank_lines_backticks_are_preserved.txt +27 -0
  92. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/module_docstring_indent_zero_is_not_inferred.txt +14 -0
  93. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/no_terminal_whitespace_only_line.txt +21 -0
  94. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/non_ascii_docstrings.txt +89 -0
  95. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/non_ascii_single_line_length_boundary.txt +11 -0
  96. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/plain_examples_code_is_preserved.txt +27 -0
  97. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_bare_type_with_description_sync.txt +26 -0
  98. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_colon_description_sync.txt +28 -0
  99. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_description_without_type_sync.txt +24 -0
  100. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/returns_yields_type_like_description_sync.txt +53 -0
  101. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/rst_code_block_backticks_are_preserved.txt +27 -0
  102. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/sections_notes_examples.txt +1 -2
  103. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_class_docstrings.txt +5 -1
  104. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_yields.txt +5 -3
  105. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/single_line_backtick_expansion_respects_line_length.txt +13 -0
  106. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/tilde_code_fence_is_preserved.txt +35 -0
  107. format_docstring-0.4.0/tests/test_data/end_to_end/numpy/yields_iterator_item_type_sync.txt +35 -0
  108. format_docstring-0.4.0/tests/test_data/integration_test/google/after.ipynb +91 -0
  109. format_docstring-0.4.0/tests/test_data/integration_test/google/after.py +34 -0
  110. format_docstring-0.4.0/tests/test_data/integration_test/google/after_50.ipynb +99 -0
  111. format_docstring-0.4.0/tests/test_data/integration_test/google/after_50.py +42 -0
  112. format_docstring-0.4.0/tests/test_data/integration_test/google/before.ipynb +78 -0
  113. format_docstring-0.4.0/tests/test_data/integration_test/numpy/before.py +24 -0
  114. format_docstring-0.4.0/tests/test_data/line_wrap/google/README.md +24 -0
  115. format_docstring-0.4.0/tests/test_data/line_wrap/google/arg_description_starts_with_bulleted_list.txt +14 -0
  116. format_docstring-0.4.0/tests/test_data/line_wrap/google/arg_description_starts_with_table.txt +20 -0
  117. format_docstring-0.4.0/tests/test_data/line_wrap/google/colon_spacing_fix.txt +21 -0
  118. format_docstring-0.4.0/tests/test_data/line_wrap/google/contents_that_are_not_wrapped.txt +88 -0
  119. format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_after_args.txt +20 -0
  120. format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_after_doctest.txt +17 -0
  121. format_docstring-0.4.0/tests/test_data/line_wrap/google/custom_section_before_args.txt +19 -0
  122. format_docstring-0.4.0/tests/test_data/line_wrap/google/default_value_standardization.txt +26 -0
  123. format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_backticks_are_preserved.txt +15 -0
  124. format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_lines_are_preserved.txt +15 -0
  125. format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_output_section_headers_are_preserved.txt +41 -0
  126. format_docstring-0.4.0/tests/test_data/line_wrap/google/doctest_plain_output_is_preserved.txt +15 -0
  127. format_docstring-0.4.0/tests/test_data/line_wrap/google/empty_lines_are_respected.txt +62 -0
  128. format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_leading_comment_is_preserved.txt +11 -0
  129. format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_plain_code_after_doctest.txt +17 -0
  130. format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_plain_output_after_code_is_preserved.txt +11 -0
  131. format_docstring-0.4.0/tests/test_data/line_wrap/google/examples_section.txt +44 -0
  132. format_docstring-0.4.0/tests/test_data/line_wrap/google/existing_linebreaks_should_not_be_respected.txt +19 -0
  133. format_docstring-0.4.0/tests/test_data/line_wrap/google/fenced_code_backticks_are_preserved.txt +13 -0
  134. format_docstring-0.4.0/tests/test_data/line_wrap/google/fix_rst_backticks.txt +83 -0
  135. format_docstring-0.4.0/tests/test_data/line_wrap/google/indent_two_levels_8_spaces.txt +13 -0
  136. format_docstring-0.4.0/tests/test_data/line_wrap/google/label_like_prose_in_notes.txt +11 -0
  137. format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_backticks_are_preserved.txt +11 -0
  138. format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_blank_lines_backticks_are_preserved.txt +19 -0
  139. format_docstring-0.4.0/tests/test_data/line_wrap/google/literal_block_marker_double_colon_preserved.txt +11 -0
  140. format_docstring-0.4.0/tests/test_data/line_wrap/google/module_level_docstring.txt +12 -0
  141. format_docstring-0.4.0/tests/test_data/line_wrap/google/no_terminal_whitespace_only_line.txt +11 -0
  142. format_docstring-0.4.0/tests/test_data/line_wrap/google/non_ascii_docstrings.txt +69 -0
  143. format_docstring-0.4.0/tests/test_data/line_wrap/google/param_signature_without_type.txt +21 -0
  144. format_docstring-0.4.0/tests/test_data/line_wrap/google/parameters_returns_raises_wrapping.txt +45 -0
  145. format_docstring-0.4.0/tests/test_data/line_wrap/google/plain_examples_code_is_preserved.txt +14 -0
  146. format_docstring-0.4.0/tests/test_data/line_wrap/google/returns_signature_and_description.txt +20 -0
  147. format_docstring-0.4.0/tests/test_data/line_wrap/google/rst_code_block_backticks_are_preserved.txt +19 -0
  148. format_docstring-0.4.0/tests/test_data/line_wrap/google/section_headings_with_colons.txt +40 -0
  149. format_docstring-0.4.0/tests/test_data/line_wrap/google/section_title_fixed.txt +40 -0
  150. format_docstring-0.4.0/tests/test_data/line_wrap/google/sections_notes_examples.txt +53 -0
  151. format_docstring-0.4.0/tests/test_data/line_wrap/google/signature_line_is_not_wrapped.txt +14 -0
  152. format_docstring-0.4.0/tests/test_data/line_wrap/google/texts_are_rewrapped.txt +113 -0
  153. format_docstring-0.4.0/tests/test_data/line_wrap/google/tilde_code_fence_is_preserved.txt +17 -0
  154. format_docstring-0.4.0/tests/test_data/line_wrap/google/variadic_signature_without_colon.txt +27 -0
  155. format_docstring-0.4.0/tests/test_data/line_wrap/google/very_long_unbreakable_word.txt +11 -0
  156. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/README.md +19 -0
  157. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/arg_description_starts_with_bulleted_list.txt +16 -0
  158. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/arg_description_starts_with_table.txt +22 -0
  159. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_after_args.txt +26 -0
  160. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_after_doctest.txt +23 -0
  161. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/custom_section_before_args.txt +25 -0
  162. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_backticks_are_preserved.txt +17 -0
  163. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_lines_are_preserved.txt +17 -0
  164. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_output_section_headers_are_preserved.txt +31 -0
  165. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/doctest_plain_output_is_preserved.txt +17 -0
  166. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_leading_comment_is_preserved.txt +13 -0
  167. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_plain_code_after_doctest.txt +19 -0
  168. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/examples_plain_output_after_code_is_preserved.txt +13 -0
  169. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/fenced_code_backticks_are_preserved.txt +15 -0
  170. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/indent_four_levels_16_spaces_width_10.txt +46 -0
  171. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/label_like_prose_in_notes.txt +13 -0
  172. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/line_length_2.txt +49 -0
  173. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_backticks_are_preserved.txt +11 -0
  174. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_blank_lines_backticks_are_preserved.txt +19 -0
  175. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/literal_block_marker_double_colon_preserved.txt +11 -0
  176. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/no_terminal_whitespace_only_line.txt +11 -0
  177. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/plain_examples_code_is_preserved.txt +16 -0
  178. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/rst_code_block_backticks_are_preserved.txt +19 -0
  179. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/sections_notes_examples.txt +1 -2
  180. format_docstring-0.4.0/tests/test_data/line_wrap/numpy/tilde_code_fence_is_preserved.txt +23 -0
  181. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_docstring_rewriter.py +281 -10
  182. format_docstring-0.4.0/tests/test_google_fixture_inventory.py +49 -0
  183. format_docstring-0.4.0/tests/test_line_wrap_google.py +244 -0
  184. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_line_wrap_numpy.py +150 -14
  185. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_line_wrap_utils.py +593 -26
  186. format_docstring-0.4.0/tests/test_main_jupyter.py +344 -0
  187. format_docstring-0.4.0/tests/test_main_py.py +286 -0
  188. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_playground.py +2 -2
  189. {format_docstring-0.2.7 → format_docstring-0.4.0}/tox.ini +10 -10
  190. format_docstring-0.2.7/PKG-INFO +0 -494
  191. format_docstring-0.2.7/README.md +0 -462
  192. format_docstring-0.2.7/format_docstring/config.py +0 -212
  193. format_docstring-0.2.7/format_docstring/line_wrap_google.py +0 -15
  194. format_docstring-0.2.7/format_docstring.egg-info/PKG-INFO +0 -494
  195. format_docstring-0.2.7/format_docstring.egg-info/SOURCES.txt +0 -112
  196. format_docstring-0.2.7/tests/test_data/end_to_end/numpy/README.md +0 -2
  197. format_docstring-0.2.7/tests/test_data/line_wrap/numpy/README.md +0 -1
  198. format_docstring-0.2.7/tests/test_line_wrap_google.py +0 -0
  199. format_docstring-0.2.7/tests/test_main_jupyter.py +0 -90
  200. format_docstring-0.2.7/tests/test_main_py.py +0 -88
  201. {format_docstring-0.2.7 → format_docstring-0.4.0}/.github/workflows/python-package.yml +0 -0
  202. {format_docstring-0.2.7 → format_docstring-0.4.0}/.github/workflows/python-publish.yml +0 -0
  203. {format_docstring-0.2.7 → format_docstring-0.4.0}/.pre-commit-hooks.yaml +0 -0
  204. {format_docstring-0.2.7 → format_docstring-0.4.0}/AGENTS.md +0 -0
  205. {format_docstring-0.2.7 → format_docstring-0.4.0}/LICENSE +0 -0
  206. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/__init__.py +0 -0
  207. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring/base_fixer.py +0 -0
  208. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/dependency_links.txt +0 -0
  209. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/entry_points.txt +0 -0
  210. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/requires.txt +0 -0
  211. {format_docstring-0.2.7 → format_docstring-0.4.0}/format_docstring.egg-info/top_level.txt +0 -0
  212. {format_docstring-0.2.7 → format_docstring-0.4.0}/requirements.dev +0 -0
  213. {format_docstring-0.2.7 → format_docstring-0.4.0}/setup.cfg +0 -0
  214. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/__init__.py +0 -0
  215. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_base_fixer.py +0 -0
  216. {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
  217. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/arg_name_is_default.txt +0 -0
  218. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/colon_spacing_fix.txt +0 -0
  219. {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
  220. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/default_value_standardization.txt +0 -0
  221. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/empty_lines_are_respected.txt +0 -0
  222. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/examples_section.txt +0 -0
  223. {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
  224. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/fix_rst_backticks.txt +0 -0
  225. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/four_level_nested_classes.txt +0 -0
  226. {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
  227. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/indent_misaligned_all.txt +0 -0
  228. {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
  229. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/line_length_2.txt +0 -0
  230. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines.txt +0 -0
  231. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines_one_dash.txt +0 -0
  232. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/mismatched_underlines_two_dashes.txt +0 -0
  233. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/module_level_docstring.txt +0 -0
  234. {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
  235. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/no_format_docstring_comment.txt +0 -0
  236. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/param_signature_without_type.txt +0 -0
  237. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/parameters_returns_raises_wrapping.txt +0 -0
  238. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/rST_cross_reference.txt +0 -0
  239. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/returns_signature_and_description.txt +0 -0
  240. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/section_headings_with_colons.txt +0 -0
  241. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/section_title_fixed.txt +0 -0
  242. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_dont_sync_raises.txt +0 -0
  243. {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
  244. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_parameters.txt +0 -0
  245. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/signature_sync_returns.txt +0 -0
  246. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/single_line_docstring.txt +0 -0
  247. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/texts_are_rewrapped.txt +0 -0
  248. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/variadic_signature_without_colon.txt +0 -0
  249. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/end_to_end/numpy/very_long_unbreakable_word.txt +0 -0
  250. {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
  251. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after.ipynb +0 -0
  252. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after.py +0 -0
  253. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after_50.ipynb +0 -0
  254. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/after_50.py +0 -0
  255. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/integration_test/numpy/before.ipynb +0 -0
  256. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/jupyter/before.ipynb +0 -0
  257. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/jupyter/verbose_before.ipynb +0 -0
  258. {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
  259. {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
  260. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/colon_spacing_fix.txt +0 -0
  261. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/contents_that_are_not_wrapped.txt +0 -0
  262. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/default_value_standardization.txt +0 -0
  263. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/empty_lines_are_respected.txt +0 -0
  264. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/examples_section.txt +0 -0
  265. {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
  266. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/fix_rst_backticks.txt +0 -0
  267. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/indent_two_levels_8_spaces.txt +0 -0
  268. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines.txt +0 -0
  269. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines_one_dash.txt +0 -0
  270. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/mismatched_underlines_two_dashes.txt +0 -0
  271. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/module_level_docstring.txt +0 -0
  272. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/non_ascii_docstrings.txt +0 -0
  273. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/param_signature_without_type.txt +0 -0
  274. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/parameters_returns_raises_wrapping.txt +0 -0
  275. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/returns_signature_and_description.txt +0 -0
  276. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/section_headings_with_colons.txt +0 -0
  277. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/section_title_fixed.txt +0 -0
  278. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/signature_line_is_not_wrapped.txt +0 -0
  279. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/texts_are_rewrapped.txt +0 -0
  280. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/variadic_signature_without_colon.txt +0 -0
  281. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/line_wrap/numpy/very_long_unbreakable_word.txt +0 -0
  282. {format_docstring-0.2.7 → format_docstring-0.4.0}/tests/test_data/playground.py +0 -0
@@ -211,3 +211,5 @@ __marimo__/
211
211
 
212
212
  # VS Code
213
213
  .vscode/
214
+
215
+ uv.lock
@@ -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.13.2
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.18.0
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.2
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.15.0
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.0
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.0
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