aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGithub Actions <actions@github>2023-11-12 02:17:31 +0000
committerGithub Actions <actions@github>2023-11-12 02:17:31 +0000
commitcb633918c84054eebac7e3301de4c741ab760110 (patch)
tree12ea7c84250d793faf915ed0d8361c679b0af268
parent9156364c23cff19734a0055377321c22b1484c0f (diff)
[docgen] Update docs
skip-checks: true
-rw-r--r--README.md3
-rw-r--r--doc/conform.txt2
2 files changed, 4 insertions, 1 deletions
diff --git a/README.md b/README.md
index 813669e..b07358d 100644
--- a/README.md
+++ b/README.md
@@ -178,7 +178,7 @@ You can view this list in vim with `:help conform-formatters`
- [alejandra](https://kamadorueda.com/alejandra/) - The Uncompromising Nix Code Formatter.
- [ast-grep](https://ast-grep.github.io/) - A CLI tool for code structural search, lint and rewriting. Written in Rust
- [astyle](https://astyle.sourceforge.net/astyle.html) - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective-C, C#, and Java Source Code.
-- [auto-optional](https://auto-optional.daanluttik.nl/) - A tool that automatically formats Python code to conform to the PEP 8 style guide.
+- [auto_optional](https://auto-optional.daanluttik.nl/) - Adds the Optional type-hint to arguments where the default value is None.
- [autoflake](https://github.com/PyCQA/autoflake) - Removes unused imports and unused variables as reported by pyflakes.
- [autopep8](https://github.com/hhatto/autopep8) - A tool that automatically formats Python code to conform to the PEP 8 style guide.
- [beautysh](https://github.com/lovesegfault/beautysh) - A Bash beautifier for the masses.
@@ -511,6 +511,7 @@ Retrieve the available formatters for a buffer
`list_all_formatters(): conform.FormatterInfo[]` \
List information about all filetype-configured formatters
+
### get_formatter_info(formatter, bufnr)
`get_formatter_info(formatter, bufnr): conform.FormatterInfo` \
diff --git a/doc/conform.txt b/doc/conform.txt
index 4cabd0e..c12fb96 100644
--- a/doc/conform.txt
+++ b/doc/conform.txt
@@ -172,6 +172,8 @@ FORMATTERS *conform-formatter
in Rust
`astyle` - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI,
Objective-C, C#, and Java Source Code.
+`auto_optional` - Adds the Optional type-hint to arguments where the default
+ value is None.
`autoflake` - Removes unused imports and unused variables as reported by
pyflakes.
`autopep8` - A tool that automatically formats Python code to conform to the PEP