From 0a340e1f227c3705ed1b0dbbbf634c98e2e82ada Mon Sep 17 00:00:00 2001 From: =?utf8?q?=C5=81ukasz=20Langa?= Date: Wed, 18 Apr 2018 18:19:04 -0700 Subject: [PATCH] Update documentation * Add "Ignore non-modified files" from the README * Add missing functions to the reference --- docs/ignoring_non_modified_files.md | 1 + docs/index.rst | 3 ++- docs/reference/reference_functions.rst | 15 +++++++++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) create mode 120000 docs/ignoring_non_modified_files.md diff --git a/docs/ignoring_non_modified_files.md b/docs/ignoring_non_modified_files.md new file mode 120000 index 0000000..3d2c7f5 --- /dev/null +++ b/docs/ignoring_non_modified_files.md @@ -0,0 +1 @@ +_build/generated/ignoring_non_modified_files.md \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index d014ed8..df59f71 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,7 +49,8 @@ Contents installation_and_usage the_black_code_style editor_integration - version_control_integration + version_control_integration + ignoring_non_modified_files contributing change_log reference/reference_summary diff --git a/docs/reference/reference_functions.rst b/docs/reference/reference_functions.rst index 8e9936d..fcfe446 100644 --- a/docs/reference/reference_functions.rst +++ b/docs/reference/reference_functions.rst @@ -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 -- 2.39.5