diff --git a/doc/persisted.nvim.txt b/doc/persisted.nvim.txt index df90f25..15e2b4c 100644 --- a/doc/persisted.nvim.txt +++ b/doc/persisted.nvim.txt @@ -165,7 +165,7 @@ As the plugin uses Vim’s `:mksession` command then you may change the Please see `:h sessionoptions` for more information. - **Note:** The author uses: `vim.o.sessionoptions = + **Note**The author uses: `vim.o.sessionoptions = "buffers,curdir,folds,globals,tabpages,winpos,winsize"` SESSION SAVE LOCATION ~ @@ -180,7 +180,7 @@ configuration option. For example: < - **Note:** The plugin may be unable to find existing sessions if the `save_dir` + **Note**The plugin may be unable to find existing sessions if the `save_dir` value is changed GIT BRANCHING ~ @@ -195,8 +195,8 @@ files for a given project, by using git branches. To enable git branching: < - **Note:** If git branching is enabled on a non git enabled repo, then `main` - will be used as the default branch + **Note**If git branching is enabled on a non git enabled repo, then `main` will + be used as the default branch AUTOSAVING ~ @@ -262,7 +262,7 @@ Autoloading can be further controlled for certain directories by specifying `allowed_dirs` and `ignored_dirs`. - **Note:** Autoloading will not occur if a user opens Neovim with arguments. For + **Note**Autoloading will not occur if a user opens Neovim with arguments. For example: `nvim some_file.rb` FOLLOWING CURRENT WORKING DIRECTORY ~ @@ -280,7 +280,7 @@ By default, the session name will match the current working directory: < - **Note:** If `follow_cwd = false` the session name is stored upon loading under + **Note**If `follow_cwd = false` the session name is stored upon loading under the global variable `vim.g.persisting_session`. This variable can be manually adjusted if changes to the session name are needed. Alternatively, if `follow_cwd = true` then `vim.g.persisting_session = nil`. @@ -303,7 +303,7 @@ Specifying `~/Code` will autosave and autoload from that directory as well as all its sub-directories. - **Note:** If `allowed_dirs` is left at its default value and `autosave` and/or + **Note**If `allowed_dirs` is left at its default value and `autosave` and/or `autoload` are set to `true`, then the plugin will autoload/autosave from _any_ directory