actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
* Add "Ignore non-modified files" from the README
* Add missing functions to the reference
This commit is contained in:
Łukasz Langa 2018-04-18 18:19:04 -07:00
parent aa5629204c
commit 0a340e1f22
3 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/ignoring_non_modified_files.md Symbolic link
View File

@ -0,0 +1 @@
_build/generated/ignoring_non_modified_files.md

3
docs/index.rst
View File

@ -49,7 +49,8 @@ Contents
installation_and_usage installation_and_usage
the_black_code_style the_black_code_style
editor_integration editor_integration
version_control_integration version_control_integration
ignoring_non_modified_files
contributing contributing
change_log change_log
reference/reference_summary reference/reference_summary

15
docs/reference/reference_functions.rst
View File

@ -39,6 +39,8 @@ Formatting
.. autofunction:: black.format_str .. autofunction:: black.format_str
.. autofunction:: black.reformat_one
.. autofunction:: black.schedule_formatting .. autofunction:: black.schedule_formatting
File operations File operations
@ -70,6 +72,17 @@ Split functions
.. autofunction:: black.bracket_split_succeeded_or_raise .. 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 Utilities
--------- ---------
@ -85,6 +98,8 @@ Utilities
.. autofunction:: black.make_comment .. autofunction:: black.make_comment
.. autofunction:: black.max_delimiter_priority_in_atom
.. autofunction:: black.normalize_prefix .. autofunction:: black.normalize_prefix
.. autofunction:: black.normalize_string_quotes .. autofunction:: black.normalize_string_quotes