Skip to content

Commit

Permalink
Add new elements to API docs and public API
Browse files Browse the repository at this point in the history
ghstack-source-id: 6c45231fcde860c5d168416cd9b82f7ac3c8dc01
Pull Request resolved: #194
  • Loading branch information
amyreese committed Feb 22, 2024
1 parent 0af70c3 commit 1d583fd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,16 @@ Simple API

.. autoclass:: ufmt.Result

.. autoclass:: ufmt.BlackConfig
.. autoclass:: ufmt.UfmtConfig

.. autoclass:: ufmt.UsortConfig
.. autoclass:: ufmt.UfmtConfigFactory

.. autoclass:: ufmt.BlackConfig

.. autoclass:: ufmt.BlackConfigFactory

.. autoclass:: ufmt.UsortConfig

.. autoclass:: ufmt.UsortConfigFactory

.. autoclass:: ufmt.Processor
Expand All @@ -47,6 +51,8 @@ Low-level API

.. autoclass:: ufmt.types.Formatter

.. autoclass:: ufmt.types.Sorter

.. autofunction:: ufmt.ufmt_bytes

.. autofunction:: ufmt.ufmt_stdin
Expand Down
6 changes: 6 additions & 0 deletions ufmt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
Processor,
Result,
SkipFormatting,
Sorter,
UfmtConfig,
UfmtConfigFactory,
UsortConfig,
UsortConfigFactory,
)
Expand All @@ -29,11 +32,14 @@
"Processor",
"Result",
"SkipFormatting",
"Sorter",
"ufmt_bytes",
"ufmt_file",
"ufmt_paths",
"ufmt_stdin",
"ufmt_string",
"UfmtConfig",
"UfmtConfigFactory",
"UsortConfig",
"UsortConfigFactory",
]

0 comments on commit 1d583fd

Please sign in to comment.