Doc: Developer reference update (#3755)

[etc/vim.git] / docs / contributing / reference / reference_classes.rst

diff --git a/docs/contributing/reference/reference_classes.rst b/docs/contributing/reference/reference_classes.rst
index 3931e0e007245682caa2c08875715925ffc40089..29b25003af28ffb801ec616f857ffd61febb6cdd 100644 (file)
--- a/docs/contributing/reference/reference_classes.rst
+++ b/docs/contributing/reference/reference_classes.rst
@@ -3,6 +3,9 @@
 
 *Contents are subject to change.*
 
 
 *Contents are subject to change.*
 

+Black Classes
+~~~~~~~~~~~~~~
+

 .. currentmodule:: black
 
 :class:`BracketTracker`
 .. currentmodule:: black
 
 :class:`BracketTracker`


@@ -18,6 +21,12 @@
     :members:
     :special-members: __str__, __bool__
 
     :members:
     :special-members: __str__, __bool__
 

+:class:`RHSResult`
+-------------------------
+
+.. autoclass:: black.lines.RHSResult
+    :members:
+

 :class:`LinesBlock`
 -------------------------
 
 :class:`LinesBlock`
 -------------------------
 


@@ -43,6 +52,12 @@
 .. autoclass:: black.comments.ProtoComment
     :members:
 
 .. autoclass:: black.comments.ProtoComment
     :members:
 

+:class:`Mode`
+---------------------
+
+.. autoclass:: black.mode.Mode
+    :members:
+

 :class:`Report`
 ---------------
 
 :class:`Report`
 ---------------
 


@@ -50,6 +65,20 @@
     :members:
     :special-members: __str__
 
     :members:
     :special-members: __str__
 

+:class:`Ok`
+---------------
+
+.. autoclass:: black.rusty.Ok
+    :show-inheritance:
+    :members:
+
+:class:`Err`
+---------------
+
+.. autoclass:: black.rusty.Err
+    :show-inheritance:
+    :members:
+

 :class:`Visitor`
 ----------------
 
 :class:`Visitor`
 ----------------
 


@@ -57,20 +86,115 @@
     :show-inheritance:
     :members:
 
     :show-inheritance:
     :members:
 

-Enums
-=====
+:class:`StringTransformer`
+----------------------------

 
 

-:class:`Changed`
-----------------
+.. autoclass:: black.trans.StringTransformer
+    :show-inheritance:
+    :members:

 
 

-.. autoclass:: black.Changed
+:class:`CustomSplit`
+----------------------------
+
+.. autoclass:: black.trans.CustomSplit
+    :members:
+
+:class:`CustomSplitMapMixin`
+-----------------------------
+
+.. autoclass:: black.trans.CustomSplitMapMixin

     :show-inheritance:
     :members:
 
     :show-inheritance:
     :members:
 

-:class:`Mode`
------------------
+:class:`StringMerger`
+----------------------

 
 

-.. autoclass:: black.Mode
+.. 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:
+
+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:
 
     :show-inheritance:
     :members:
 


@@ -80,3 +204,24 @@ Enums
 .. autoclass:: black.WriteBack
     :show-inheritance:
     :members:
 .. 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: