]> git.madduck.net Git - etc/vim.git/blob - docs/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:

4e7fb837222d1d0f477f85c2a2823a9ba0d6d461
[etc/vim.git] / docs / reference / reference_functions.rst
1 *Black* functions
2 =================
3
4 *Contents are subject to change.*
5
6 .. currentmodule:: black
7
8 Assertions and checks
9 ---------------------
10
11 .. autofunction:: black.assert_equivalent
12
13 .. autofunction:: black.assert_stable
14
15 .. autofunction:: black.is_split_after_delimiter
16
17 .. autofunction:: black.is_split_before_delimiter
18
19 .. autofunction:: black.is_delimiter
20
21 .. autofunction:: black.is_import
22
23 .. autofunction:: black.is_python36
24
25 Formatting
26 ----------
27
28 .. autofunction:: black.format_file_contents
29
30 .. autofunction:: black.format_file_in_place
31
32 .. autofunction:: black.format_stdin_to_stdout
33
34 .. autofunction:: black.format_str
35
36 .. autofunction:: black.schedule_formatting
37
38 File operations
39 ---------------
40
41 .. autofunction:: black.dump_to_file
42
43 .. autofunction:: black.gen_python_files_in_dir
44
45 Parsing
46 -------
47
48 .. autofunction:: black.lib2to3_parse
49
50 .. autofunction:: black.lib2to3_unparse
51
52 Split functions
53 ---------------
54
55 .. autofunction:: black.delimiter_split
56
57 .. autofunction:: black.left_hand_split
58
59 .. autofunction:: black.right_hand_split
60
61 .. autofunction:: black.split_line
62
63 .. autofunction:: black.bracket_split_succeeded_or_raise
64
65 Utilities
66 ---------
67
68 .. py:function:: black.DebugVisitor.show(code: str) -> None
69
70     Pretty-print the lib2to3 AST of a given string of `code`.
71
72 .. autofunction:: black.diff
73
74 .. autofunction:: black.generate_comments
75
76 .. autofunction:: black.make_comment
77
78 .. autofunction:: black.normalize_prefix
79
80 .. autofunction:: black.normalize_string_quotes
81
82 .. autofunction:: black.preceding_leaf
83
84 .. autofunction:: black.whitespace