Skip to content

Commit 5bad3cf

Browse files
committed
docs: update docs
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
1 parent 2bd4dbd commit 5bad3cf

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

doc/project-nvim.txt

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ Table of Contents *project-nvim.toc*
5151
7.11. `:ProjectConfig` |:ProjectConfig|
5252
7.12. `:ProjectDelete` |:ProjectDelete|
5353
7.13. `:ProjectSession` |:ProjectSession|
54-
7.14. `:ProjectExportJSON` |:ProjectExportJSON|
55-
7.15. `:ProjectImportJSON` |:ProjectImportJSON|
54+
7.14. `:ProjectExport` |:ProjectExport|
55+
7.15. `:ProjectImport` |:ProjectImport|
5656
8. API |project-nvim.api|
5757
8.1. `get_project_root()` |project-nvim.get_project_root()|
5858
8.2. `get_recent_projects()` |project-nvim.get_recent_projects()|
@@ -703,9 +703,10 @@ Table of Contents *project-nvim.toc*
703703
The `:ProjectFzf` command is a
704704
dynamically enabled user command that runs
705705
`project.nvim` through `fzf-lua`.
706-
For now it just executes
707-
`require('project.extensions.fzf-lua').run_fzf_lua()`
708-
706+
For now it just executes:
707+
>lua
708+
require('project.extensions.fzf-lua').run_fzf_lua()
709+
<
709710

710711
`:ProjectPicker[!]` *ProjectPicker* *:ProjectPicker*
711712

@@ -844,15 +845,15 @@ Table of Contents *project-nvim.toc*
844845
UI picker with its contents, and so on...
845846

846847

847-
`:ProjectExportJSON[!] [</path/to/file[.json]> [<INDENT>]]` *:ProjectExportJSON*
848-
*ProjectExportJSON*
848+
`:ProjectExport[!] [</path/to/file[.json]> [<INDENT>]]` *:ProjectExport*
849+
*ProjectExport*
849850

850851
WARNING ~
851852
Use this script with caution! ~
852853
You may overwrite important files ~
853854
if doing something reckless! ~
854855

855-
The `:ProjectExportJSON` user command
856+
The `:ProjectExport` user command
856857
allows the user to save their project history
857858
in a JSON format, allowing a custom indent level
858859
if desired.
@@ -861,34 +862,34 @@ Table of Contents *project-nvim.toc*
861862
and is not empty then a confirmation prompt
862863
will appear.
863864
>vim
864-
:ProjectExportJSON " Will open a prompt
865+
:ProjectExport " Will open a prompt
865866

866-
:ProjectExportJSON a " Output file is `a.json`
867+
:ProjectExport a " Output file is `a.json`
867868

868-
:ProjectExportJSON! b 12 " Output file is `b`, with a tab size of 12
869+
:ProjectExport! b 12 " Output file is `b`, with a tab size of 12
869870

870871
" The output file will be `~/.c.json` (bang here is irrelevant)
871-
:ProjectExportJSON! ~/.c.json
872+
:ProjectExport! ~/.c.json
872873
<
873874

874-
`:ProjectImportJSON[!] [</path/to/file[.json]>]` *:ProjectImportJSON*
875-
*ProjectImportJSON*
875+
`:ProjectImport[!] [</path/to/file[.json]>]` *:ProjectImport*
876+
*ProjectImport*
876877

877-
The `:ProjectImportJSON` allows the user
878+
The `:ProjectImport` allows the user
878879
to retrieve their saved project history
879880
in a JSON format
880881
>vim
881882

882883
" Will open a prompt
883-
:ProjectImportJSON
884+
:ProjectImport
884885

885886
" Will be treated as `a.json`
886-
:ProjectExportJSON a
887-
:ProjectImportJSON a
887+
:ProjectExport a
888+
:ProjectImport a
888889

889890
" Will be treated as `b`
890-
:ProjectExportJSON! b
891-
:ProjectImportJSON! b
891+
:ProjectExport! b
892+
:ProjectImport! b
892893
<
893894

894895
==============================================================================

0 commit comments

Comments
 (0)