misc: fix documentation generation

This commit is contained in:
Gaetan Lepage 2023-06-26 08:51:36 +02:00 committed by Gaétan Lepage
parent 794356625c
commit be6a29c800
2 changed files with 98 additions and 101 deletions

View file

@ -609,7 +609,10 @@ in {
nowait = helpers.defaultNullOpts.mkBool true "nowait";
};
mappings = mkMappingsOption ''
mappings =
mkMappingsOption
''
```
{
"<space>" = {
command = "toggle_node";
@ -657,10 +660,12 @@ in {
"<" = "prev_source";
">" = "next_source";
}
```
'';
};
filesystem = helpers.mkCompositeOption "Filesystem options" {
window = mkWindowMappingsOption ''
window = mkWindowMappingsOption (lib.mdDoc ''
```
{
H = "toggle_hidden";
"/" = "fuzzy_finder";
@ -675,7 +680,8 @@ in {
"[g" = "prev_git_modified";
"]g" = "next_git_modified";
}
'';
```
'');
asyncDirectoryScan = helpers.defaultNullOpts.mkEnumFirstDefault ["auto" "always" "never"] ''
- "auto" means refreshes are async, but it's synchronous when called from the Neotree
commands.
@ -719,48 +725,39 @@ in {
"only works on Windows for hidden files/directories";
hideByName =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) ''
[
".DS_Store"
"thumbs.db"
# "node_modules"
]
''
helpers.defaultNullOpts.mkNullable (types.listOf types.str)
''[".DS_Store" "thumbs.db"]''
"hide by name";
hideByPattern =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) ''
[
# "*.meta"
# "*/src/*/tsconfig.json"
]
''
"hide by pattern";
hideByPattern = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
Hide by pattern.
alwaysShow =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) ''
Example:
```
[
# ".gitignored"
"*.meta"
"*/src/*/tsconfig.json"
]
''
"files/folders to always show";
```
'';
neverShow =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) ''
[
# ".DS_Store"
# "thumbs.db"
]
''
"files/folders to never show";
alwaysShow = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
Files/folders to always show.
neverShowByPattern =
helpers.defaultNullOpts.mkNullable (types.listOf types.str) ''
[
# ".null-ls_*"
]
''
"files/folders to never show (by pattern)";
Example: `[".gitignore"]`
'';
neverShow = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
Files/folders to never show.
Example: `[".DS_Store" "thumbs.db"]`
'';
neverShowByPattern = helpers.defaultNullOpts.mkNullable (types.listOf types.str) "[]" ''
Files/folders to never show (by pattern).
Example: `[".null-ls_*"]`
'';
};
findByFullPathWords = helpers.defaultNullOpts.mkBool false ''

View file

@ -284,7 +284,7 @@ in {
latex = {
commands = helpers.defaultNullOpts.mkNullable (with types; attrsOf str) "{}" ''
List of LATEX commands to be handled by the LATEX parser, listed together with empty arguments
(e.g., "\ref{}", "\documentclass[]{}").
(e.g., `"ref{}"`, `"\documentclass[]{}"`).
This setting is an attrs with the commands as keys and corresponding actions as values.