X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/d01460d9393d611c0673723320f7a1e50c424e21..788f87cb58dbdb20df8adbb9ab4efaee1c5e00f2:/docs/reference/reference_functions.rst?ds=inline diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst index 098f155..dffde25 100644 --- a/docs/reference/reference_functions.rst +++ b/docs/reference/reference_functions.rst @@ -12,12 +12,35 @@ Assertions and checks .. autofunction:: black.assert_stable -.. autofunction:: black.is_delimiter +.. autofunction:: black.can_be_split + +.. autofunction:: black.can_omit_invisible_parens + +.. autofunction:: black.is_empty_tuple .. autofunction:: black.is_import +.. autofunction:: black.is_line_short_enough + +.. autofunction:: black.is_multiline_string + +.. autofunction:: black.is_one_tuple + .. autofunction:: black.is_python36 +.. autofunction:: black.is_split_after_delimiter + +.. autofunction:: black.is_split_before_delimiter + +.. autofunction:: black.is_stub_body + +.. autofunction:: black.is_stub_suite + +.. autofunction:: black.is_vararg + +.. autofunction:: black.is_yield + + Formatting ---------- @@ -29,6 +52,8 @@ Formatting .. autofunction:: black.format_str +.. autofunction:: black.reformat_one + .. autofunction:: black.schedule_formatting File operations @@ -36,11 +61,17 @@ File operations .. autofunction:: black.dump_to_file +.. autofunction:: black.find_project_root + .. autofunction:: black.gen_python_files_in_dir +.. autofunction:: black.read_pyproject_toml + Parsing ------- +.. autofunction:: black.decode_bytes + .. autofunction:: black.lib2to3_parse .. autofunction:: black.lib2to3_unparse @@ -48,27 +79,100 @@ Parsing Split functions --------------- +.. autofunction:: black.bracket_split_build_line + +.. autofunction:: black.bracket_split_succeeded_or_raise + .. autofunction:: black.delimiter_split .. autofunction:: black.left_hand_split .. autofunction:: black.right_hand_split +.. autofunction:: black.standalone_comment_split + .. autofunction:: black.split_line -.. autofunction:: black.bracket_split_succeeded_or_raise +Caching +------- + +.. autofunction:: black.filter_cached + +.. autofunction:: black.get_cache_file + +.. autofunction:: black.get_cache_info + +.. autofunction:: black.read_cache + +.. autofunction:: black.write_cache Utilities --------- +.. py:function:: black.DebugVisitor.show(code: str) -> None + + Pretty-print the lib2to3 AST of a given string of `code`. + +.. autofunction:: black.cancel + +.. autofunction:: black.child_towards + +.. autofunction:: black.container_of + +.. autofunction:: black.convert_one_fmt_off_pair + .. autofunction:: black.diff +.. autofunction:: black.dont_increase_indentation + +.. autofunction:: black.format_float_or_int_string + +.. autofunction:: black.format_int_string + +.. autofunction:: black.ensure_visible + +.. autofunction:: black.enumerate_reversed + +.. autofunction:: black.enumerate_with_length + .. autofunction:: black.generate_comments +.. autofunction:: black.generate_ignored_nodes + +.. autofunction:: black.generate_trailers_to_omit + +.. autofunction:: black.get_future_imports + +.. autofunction:: black.list_comments + .. autofunction:: black.make_comment +.. autofunction:: black.maybe_make_parens_invisible_in_atom + +.. autofunction:: black.max_delimiter_priority_in_atom + +.. autofunction:: black.normalize_fmt_off + +.. autofunction:: black.normalize_numeric_literal + .. autofunction:: black.normalize_prefix +.. autofunction:: black.normalize_string_prefix + +.. autofunction:: black.normalize_string_quotes + +.. autofunction:: black.normalize_invisible_parens + +.. autofunction:: black.patch_click + .. autofunction:: black.preceding_leaf +.. autofunction:: black.re_compile_maybe_verbose + +.. autofunction:: black.should_explode + +.. autofunction:: black.shutdown + +.. autofunction:: black.sub_twice + .. autofunction:: black.whitespace