Remove reference (#4169)
This is out-of-date and just a chore. I don't think this is useful to contributors and Black doesn't even have a public API.
This commit is contained in:
Shantanu
GitHub
parent
a5196e6f1f
commit
f7d552d9b7
@ -9,7 +9,6 @@ the_basics
|
|||||||
gauging_changes
|
gauging_changes
|
||||||
issue_triage
|
issue_triage
|
||||||
release_process
|
release_process
|
||||||
reference/reference_summary
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Welcome! Happy to see you willing to make the project better. Have you read the entire
|
Welcome! Happy to see you willing to make the project better. Have you read the entire
|
||||||
@ -42,9 +41,5 @@ This section covers the following topics:
|
|||||||
- {doc}`the_basics`
|
- {doc}`the_basics`
|
||||||
- {doc}`gauging_changes`
|
- {doc}`gauging_changes`
|
||||||
- {doc}`release_process`
|
- {doc}`release_process`
|
||||||
- {doc}`reference/reference_summary`
|
|
||||||
|
|
||||||
For an overview on contributing to the _Black_, please checkout {doc}`the_basics`.
|
For an overview on contributing to the _Black_, please checkout {doc}`the_basics`.
|
||||||
|
|
||||||
If you need a reference of the functions, classes, etc. available to you while
|
|
||||||
developing _Black_, there's the {doc}`reference/reference_summary` docs.
|
|
||||||
|
|||||||
@ -1,234 +0,0 @@
|
|||||||
*Black* classes
|
|
||||||
===============
|
|
||||||
|
|
||||||
*Contents are subject to change.*
|
|
||||||
|
|
||||||
Black Classes
|
|
||||||
~~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
.. currentmodule:: black
|
|
||||||
|
|
||||||
:class:`BracketTracker`
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.brackets.BracketTracker
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Line`
|
|
||||||
-------------
|
|
||||||
|
|
||||||
.. autoclass:: black.lines.Line
|
|
||||||
:members:
|
|
||||||
:special-members: __str__, __bool__
|
|
||||||
|
|
||||||
:class:`RHSResult`
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.lines.RHSResult
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`LinesBlock`
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.lines.LinesBlock
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`EmptyLineTracker`
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.lines.EmptyLineTracker
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`LineGenerator`
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.linegen.LineGenerator
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`ProtoComment`
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.comments.ProtoComment
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Mode`
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.mode.Mode
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Report`
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. autoclass:: black.report.Report
|
|
||||||
:members:
|
|
||||||
:special-members: __str__
|
|
||||||
|
|
||||||
:class:`Ok`
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. autoclass:: black.rusty.Ok
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Err`
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. autoclass:: black.rusty.Err
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Visitor`
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. autoclass:: black.nodes.Visitor
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringTransformer`
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringTransformer
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`CustomSplit`
|
|
||||||
----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.CustomSplit
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`CustomSplitMapMixin`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.CustomSplitMapMixin
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringMerger`
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringMerger
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringParenStripper`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringParenStripper
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`BaseStringSplitter`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.BaseStringSplitter
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringSplitter`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringSplitter
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringParenWrapper`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringParenWrapper
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`StringParser`
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.trans.StringParser
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`DebugVisitor`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.debug.DebugVisitor
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Replacement`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.handle_ipynb_magics.Replacement
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`CellMagic`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.handle_ipynb_magics.CellMagic
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`CellMagicFinder`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.handle_ipynb_magics.CellMagicFinder
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`OffsetAndMagic`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.handle_ipynb_magics.OffsetAndMagic
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`MagicFinder`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.handle_ipynb_magics.MagicFinder
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Cache`
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.cache.Cache
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
Enum Classes
|
|
||||||
~~~~~~~~~~~~~
|
|
||||||
|
|
||||||
Classes inherited from Python `Enum <https://docs.python.org/3/library/enum.html#enum.Enum>`_ class.
|
|
||||||
|
|
||||||
:class:`Changed`
|
|
||||||
----------------
|
|
||||||
|
|
||||||
.. autoclass:: black.report.Changed
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`WriteBack`
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.WriteBack
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`TargetVersion`
|
|
||||||
----------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.mode.TargetVersion
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Feature`
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.mode.Feature
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
|
|
||||||
:class:`Preview`
|
|
||||||
------------------
|
|
||||||
|
|
||||||
.. autoclass:: black.mode.Preview
|
|
||||||
:show-inheritance:
|
|
||||||
:members:
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
*Black* exceptions
|
|
||||||
==================
|
|
||||||
|
|
||||||
*Contents are subject to change.*
|
|
||||||
|
|
||||||
.. currentmodule:: black
|
|
||||||
|
|
||||||
.. autoexception:: black.trans.CannotTransform
|
|
||||||
|
|
||||||
.. autoexception:: black.linegen.CannotSplit
|
|
||||||
|
|
||||||
.. autoexception:: black.brackets.BracketMatchError
|
|
||||||
|
|
||||||
.. autoexception:: black.report.NothingChanged
|
|
||||||
|
|
||||||
.. autoexception:: black.parsing.InvalidInput
|
|
||||||
|
|
||||||
.. autoexception:: black.mode.Deprecated
|
|
||||||
@ -1,172 +0,0 @@
|
|||||||
*Black* functions
|
|
||||||
=================
|
|
||||||
|
|
||||||
*Contents are subject to change.*
|
|
||||||
|
|
||||||
.. currentmodule:: black
|
|
||||||
|
|
||||||
Assertions and checks
|
|
||||||
---------------------
|
|
||||||
|
|
||||||
.. autofunction:: black.assert_equivalent
|
|
||||||
|
|
||||||
.. autofunction:: black.assert_stable
|
|
||||||
|
|
||||||
.. autofunction:: black.lines.can_be_split
|
|
||||||
|
|
||||||
.. autofunction:: black.lines.can_omit_invisible_parens
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_empty_tuple
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_import
|
|
||||||
|
|
||||||
.. autofunction:: black.lines.is_line_short_enough
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_multiline_string
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_one_tuple
|
|
||||||
|
|
||||||
.. autofunction:: black.brackets.is_split_after_delimiter
|
|
||||||
|
|
||||||
.. autofunction:: black.brackets.is_split_before_delimiter
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_stub_body
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_stub_suite
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_vararg
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.is_yield
|
|
||||||
|
|
||||||
|
|
||||||
Formatting
|
|
||||||
----------
|
|
||||||
|
|
||||||
.. autofunction:: black.format_file_contents
|
|
||||||
|
|
||||||
.. autofunction:: black.format_file_in_place
|
|
||||||
|
|
||||||
.. autofunction:: black.format_stdin_to_stdout
|
|
||||||
|
|
||||||
.. autofunction:: black.format_str
|
|
||||||
|
|
||||||
.. autofunction:: black.reformat_one
|
|
||||||
|
|
||||||
.. autofunction:: black.concurrency.schedule_formatting
|
|
||||||
|
|
||||||
File operations
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. autofunction:: black.dump_to_file
|
|
||||||
|
|
||||||
.. autofunction:: black.find_project_root
|
|
||||||
|
|
||||||
.. autofunction:: black.gen_python_files
|
|
||||||
|
|
||||||
.. autofunction:: black.read_pyproject_toml
|
|
||||||
|
|
||||||
Parsing
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. autofunction:: black.decode_bytes
|
|
||||||
|
|
||||||
.. autofunction:: black.parsing.lib2to3_parse
|
|
||||||
|
|
||||||
.. autofunction:: black.parsing.lib2to3_unparse
|
|
||||||
|
|
||||||
Split functions
|
|
||||||
---------------
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.bracket_split_build_line
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.bracket_split_succeeded_or_raise
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.delimiter_split
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.left_hand_split
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.right_hand_split
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.standalone_comment_split
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.transform_line
|
|
||||||
|
|
||||||
Caching
|
|
||||||
-------
|
|
||||||
|
|
||||||
.. autofunction:: black.cache.get_cache_dir
|
|
||||||
|
|
||||||
.. autofunction:: black.cache.get_cache_file
|
|
||||||
|
|
||||||
Utilities
|
|
||||||
---------
|
|
||||||
|
|
||||||
.. py:function:: black.debug.DebugVisitor.show(code: str) -> None
|
|
||||||
|
|
||||||
Pretty-print the lib2to3 AST of a given string of `code`.
|
|
||||||
|
|
||||||
.. autofunction:: black.concurrency.cancel
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.child_towards
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.container_of
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.convert_one_fmt_off_pair
|
|
||||||
|
|
||||||
.. autofunction:: black.diff
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.dont_increase_indentation
|
|
||||||
|
|
||||||
.. autofunction:: black.numerics.format_float_or_int_string
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.ensure_visible
|
|
||||||
|
|
||||||
.. autofunction:: black.lines.enumerate_reversed
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.generate_comments
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.generate_ignored_nodes
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.is_fmt_on
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.children_contains_fmt_on
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.first_leaf_of
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.generate_trailers_to_omit
|
|
||||||
|
|
||||||
.. autofunction:: black.get_future_imports
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.list_comments
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.make_comment
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.maybe_make_parens_invisible_in_atom
|
|
||||||
|
|
||||||
.. autofunction:: black.brackets.max_delimiter_priority_in_atom
|
|
||||||
|
|
||||||
.. autofunction:: black.normalize_fmt_off
|
|
||||||
|
|
||||||
.. autofunction:: black.numerics.normalize_numeric_literal
|
|
||||||
|
|
||||||
.. autofunction:: black.comments.normalize_trailing_prefix
|
|
||||||
|
|
||||||
.. autofunction:: black.strings.normalize_string_prefix
|
|
||||||
|
|
||||||
.. autofunction:: black.strings.normalize_string_quotes
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.normalize_invisible_parens
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.preceding_leaf
|
|
||||||
|
|
||||||
.. autofunction:: black.re_compile_maybe_verbose
|
|
||||||
|
|
||||||
.. autofunction:: black.linegen.should_split_line
|
|
||||||
|
|
||||||
.. autofunction:: black.concurrency.shutdown
|
|
||||||
|
|
||||||
.. autofunction:: black.strings.sub_twice
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.whitespace
|
|
||||||
|
|
||||||
.. autofunction:: black.nodes.make_simple_prefix
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
Developer reference
|
|
||||||
===================
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
As of June 2023, the documentation of *Black classes* and *Black exceptions*
|
|
||||||
has been updated to the latest available version.
|
|
||||||
|
|
||||||
The documentation of *Black functions* is quite outdated and has been neglected. Many
|
|
||||||
functions worthy of inclusion aren't documented. Contributions are appreciated!
|
|
||||||
|
|
||||||
*Contents are subject to change.*
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
reference_classes
|
|
||||||
reference_functions
|
|
||||||
reference_exceptions
|
|
||||||
Loading…
Reference in New Issue
Block a user