Rewrite mostly useless assert in test_trans.py (#3810)

[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 8a2ded9dfeca752d11389142a18315faeb3692d3..29b25003af28ffb801ec616f857ffd61febb6cdd 100644 (file)
--- a/docs/contributing/reference/reference_classes.rst
+++ b/docs/contributing/reference/reference_classes.rst
@@ -3,68 +3,198 @@
 
 *Contents are subject to change.*
 
 
 *Contents are subject to change.*
 

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

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

-.. autoclass:: black.BracketTracker
+.. autoclass:: black.brackets.BracketTracker

     :members:
 
     :members:
 

-:class:`EmptyLineTracker`
+:class:`Line`
+-------------
+
+.. autoclass:: black.lines.Line
+    :members:
+    :special-members: __str__, __bool__
+
+:class:`RHSResult`

 -------------------------
 
 -------------------------
 

-.. autoclass:: black.EmptyLineTracker
+.. autoclass:: black.lines.RHSResult

     :members:
 
     :members:
 

-:class:`Line`
--------------
+:class:`LinesBlock`
+-------------------------

 
 

-.. autoclass:: black.Line
+.. autoclass:: black.lines.LinesBlock
+    :members:
+
+:class:`EmptyLineTracker`
+-------------------------
+
+.. autoclass:: black.lines.EmptyLineTracker

     :members:
     :members:

-    :special-members: __str__, __bool__

 
 :class:`LineGenerator`
 ----------------------
 
 
 :class:`LineGenerator`
 ----------------------
 

-.. autoclass:: black.LineGenerator
+.. autoclass:: black.linegen.LineGenerator

     :show-inheritance:
     :members:
 
 :class:`ProtoComment`
 ---------------------
 
     :show-inheritance:
     :members:
 
 :class:`ProtoComment`
 ---------------------
 

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

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

-.. autoclass:: black.Report
+.. autoclass:: black.report.Report

     :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`
 ----------------
 

-.. autoclass:: black.Visitor
+.. autoclass:: black.nodes.Visitor

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

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

 
 

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

 
 

-.. autoclass:: black.Changed
+.. 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:
 


@@ -74,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: