]> git.madduck.net Git - etc/vim.git/blobdiff - docs/contributing/reference/reference_functions.rst

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Update documentation regarding isort compatibility (#3567)
[etc/vim.git] / docs / contributing / reference / reference_functions.rst
diff --git a/docs/contributing/reference/reference_functions.rst b/docs/contributing/reference/reference_functions.rst
index bffce7e9e325b439ed1ad33d7b359f8f0372f512..3bda5de1774ce35a0091619e5fd3a5a95c5cef33 100644 (file)
--- a/docs/contributing/reference/reference_functions.rst
+++ b/docs/contributing/reference/reference_functions.rst
@@ -12,31 +12,31 @@ Assertions and checks
 
 .. autofunction:: black.assert_stable
 
 
 .. autofunction:: black.assert_stable
 
-.. autofunction:: black.can_be_split
+.. autofunction:: black.lines.can_be_split
 
 
-.. autofunction:: black.can_omit_invisible_parens
+.. autofunction:: black.lines.can_omit_invisible_parens
 
 
-.. autofunction:: black.is_empty_tuple
+.. autofunction:: black.nodes.is_empty_tuple
 
 
-.. autofunction:: black.is_import
+.. autofunction:: black.nodes.is_import
 
 
-.. autofunction:: black.is_line_short_enough
+.. autofunction:: black.lines.is_line_short_enough
 
 
-.. autofunction:: black.is_multiline_string
+.. autofunction:: black.nodes.is_multiline_string
 
 
-.. autofunction:: black.is_one_tuple
+.. autofunction:: black.nodes.is_one_tuple
 
 
-.. autofunction:: black.is_split_after_delimiter
+.. autofunction:: black.brackets.is_split_after_delimiter
 
 
-.. autofunction:: black.is_split_before_delimiter
+.. autofunction:: black.brackets.is_split_before_delimiter
 
 
-.. autofunction:: black.is_stub_body
+.. autofunction:: black.nodes.is_stub_body
 
 
-.. autofunction:: black.is_stub_suite
+.. autofunction:: black.nodes.is_stub_suite
 
 
-.. autofunction:: black.is_vararg
+.. autofunction:: black.nodes.is_vararg
 
 
-.. autofunction:: black.is_yield
+.. autofunction:: black.nodes.is_yield
 
 
 Formatting
 
 
 Formatting
@@ -52,7 +52,7 @@ Formatting
 
 .. autofunction:: black.reformat_one
 
 
 .. autofunction:: black.reformat_one
 
-.. autofunction:: black.schedule_formatting
+.. autofunction:: black.concurrency.schedule_formatting
 
 File operations
 ---------------
 
 File operations
 ---------------
@@ -70,111 +70,111 @@ Parsing
 
 .. autofunction:: black.decode_bytes
 
 
 .. autofunction:: black.decode_bytes
 
-.. autofunction:: black.lib2to3_parse
+.. autofunction:: black.parsing.lib2to3_parse
 
 
-.. autofunction:: black.lib2to3_unparse
+.. autofunction:: black.parsing.lib2to3_unparse
 
 Split functions
 ---------------
 
 
 Split functions
 ---------------
 
-.. autofunction:: black.bracket_split_build_line
+.. autofunction:: black.linegen.bracket_split_build_line
 
 
-.. autofunction:: black.bracket_split_succeeded_or_raise
+.. autofunction:: black.linegen.bracket_split_succeeded_or_raise
 
 
-.. autofunction:: black.delimiter_split
+.. autofunction:: black.linegen.delimiter_split
 
 
-.. autofunction:: black.left_hand_split
+.. autofunction:: black.linegen.left_hand_split
 
 
-.. autofunction:: black.right_hand_split
+.. autofunction:: black.linegen.right_hand_split
 
 
-.. autofunction:: black.standalone_comment_split
+.. autofunction:: black.linegen.standalone_comment_split
 
 
-.. autofunction:: black.transform_line
+.. autofunction:: black.linegen.transform_line
 
 Caching
 -------
 
 
 Caching
 -------
 
-.. autofunction:: black.filter_cached
+.. autofunction:: black.cache.filter_cached
 
 
-.. autofunction:: black.get_cache_file
+.. autofunction:: black.cache.get_cache_dir
 
 
-.. autofunction:: black.get_cache_info
+.. autofunction:: black.cache.get_cache_file
 
 
-.. autofunction:: black.read_cache
+.. autofunction:: black.cache.get_cache_info
 
 
-.. autofunction:: black.write_cache
+.. autofunction:: black.cache.read_cache
+
+.. autofunction:: black.cache.write_cache
 
 Utilities
 ---------
 
 
 Utilities
 ---------
 
-.. py:function:: black.DebugVisitor.show(code: str) -> None
+.. py:function:: black.debug.DebugVisitor.show(code: str) -> None
 
     Pretty-print the lib2to3 AST of a given string of `code`.
 
 
     Pretty-print the lib2to3 AST of a given string of `code`.
 
-.. autofunction:: black.cancel
+.. autofunction:: black.concurrency.cancel
 
 
-.. autofunction:: black.child_towards
+.. autofunction:: black.nodes.child_towards
 
 
-.. autofunction:: black.container_of
+.. autofunction:: black.nodes.container_of
 
 
-.. autofunction:: black.convert_one_fmt_off_pair
+.. autofunction:: black.comments.convert_one_fmt_off_pair
 
 .. autofunction:: black.diff
 
 
 .. autofunction:: black.diff
 
-.. autofunction:: black.dont_increase_indentation
-
-.. autofunction:: black.format_float_or_int_string
+.. autofunction:: black.linegen.dont_increase_indentation
 
 
-.. autofunction:: black.ensure_visible
+.. autofunction:: black.numerics.format_float_or_int_string
 
 
-.. autofunction:: black.enumerate_reversed
+.. autofunction:: black.nodes.ensure_visible
 
 
-.. autofunction:: black.enumerate_with_length
+.. autofunction:: black.lines.enumerate_reversed
 
 
-.. autofunction:: black.generate_comments
+.. autofunction:: black.comments.generate_comments
 
 
-.. autofunction:: black.generate_ignored_nodes
+.. autofunction:: black.comments.generate_ignored_nodes
 
 
-.. autofunction:: black.is_fmt_on
+.. autofunction:: black.comments.is_fmt_on
 
 
-.. autofunction:: black.contains_fmt_on_at_column
+.. autofunction:: black.comments.children_contains_fmt_on
 
 
-.. autofunction:: black.first_leaf_column
+.. autofunction:: black.nodes.first_leaf_of
 
 
-.. autofunction:: black.generate_trailers_to_omit
+.. autofunction:: black.linegen.generate_trailers_to_omit
 
 .. autofunction:: black.get_future_imports
 
 
 .. autofunction:: black.get_future_imports
 
-.. autofunction:: black.list_comments
+.. autofunction:: black.comments.list_comments
 
 
-.. autofunction:: black.make_comment
+.. autofunction:: black.comments.make_comment
 
 
-.. autofunction:: black.maybe_make_parens_invisible_in_atom
+.. autofunction:: black.linegen.maybe_make_parens_invisible_in_atom
 
 
-.. autofunction:: black.max_delimiter_priority_in_atom
+.. autofunction:: black.brackets.max_delimiter_priority_in_atom
 
 .. autofunction:: black.normalize_fmt_off
 
 
 .. autofunction:: black.normalize_fmt_off
 
-.. autofunction:: black.normalize_numeric_literal
+.. autofunction:: black.numerics.normalize_numeric_literal
 
 
-.. autofunction:: black.normalize_prefix
+.. autofunction:: black.linegen.normalize_prefix
 
 
-.. autofunction:: black.normalize_string_prefix
+.. autofunction:: black.strings.normalize_string_prefix
 
 
-.. autofunction:: black.normalize_string_quotes
+.. autofunction:: black.strings.normalize_string_quotes
 
 
-.. autofunction:: black.normalize_invisible_parens
+.. autofunction:: black.linegen.normalize_invisible_parens
 
 .. autofunction:: black.patch_click
 
 
 .. autofunction:: black.patch_click
 
-.. autofunction:: black.preceding_leaf
+.. autofunction:: black.nodes.preceding_leaf
 
 .. autofunction:: black.re_compile_maybe_verbose
 
 
 .. autofunction:: black.re_compile_maybe_verbose
 
-.. autofunction:: black.should_split_line
+.. autofunction:: black.linegen.should_split_line
 
 
-.. autofunction:: black.shutdown
+.. autofunction:: black.concurrency.shutdown
 
 
-.. autofunction:: black.sub_twice
+.. autofunction:: black.strings.sub_twice
 
 
-.. autofunction:: black.whitespace
+.. autofunction:: black.nodes.whitespace
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.