Commit 0a340e1f authored by Łukasz Langa's avatar Łukasz Langa
Browse files

Update documentation

* Add "Ignore non-modified files" from the README
* Add missing functions to the reference
parent aa562920
Loading
Loading
Loading
Loading
+1 −0
Changes for docs/ignoring_non_modified_files.md: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
_build/generated/ignoring_non_modified_files.md
 No newline at end of file
+1 −0
Changes for docs/index.rst: 1 added line, 0 removed lines.
Original line number Diff line number Diff line
@@ -50,6 +50,7 @@ Contents
   the_black_code_style
   editor_integration
   version_control_integration
   ignoring_non_modified_files
   contributing
   change_log
   reference/reference_summary
+15 −0
Changes for docs/reference/reference_functions.rst: 15 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -39,6 +39,8 @@ Formatting

.. autofunction:: black.format_str

.. autofunction:: black.reformat_one

.. autofunction:: black.schedule_formatting

File operations
@@ -70,6 +72,17 @@ Split functions

.. autofunction:: black.bracket_split_succeeded_or_raise

Caching
-------

.. autofunction:: black.filter_cached

.. autofunction:: black.get_cache_info

.. autofunction:: black.read_cache

.. autofunction:: black.write_cache

Utilities
---------

@@ -85,6 +98,8 @@ Utilities

.. autofunction:: black.make_comment

.. autofunction:: black.max_delimiter_priority_in_atom

.. autofunction:: black.normalize_prefix

.. autofunction:: black.normalize_string_quotes