Skip to content

Commit

Permalink
[docgen] Update docs
Browse files Browse the repository at this point in the history 
skip-checks: true
  • Loading branch information
Github Actions committed Nov 28, 2024
1 parent 35af2d4 commit d3b6b36
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 40 deletions.
72 changes: 36 additions & 36 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -406,72 +406,72 @@ Detach from the current session
`list(opts): string[]` \
List all available saved sessions

| Param | Type | Desc | |
| ----- | ------------------------- | ------------- | ------------------------------------------------ |
| opts | `nil\|resession.ListOpts` | | |
| | dir | `nil\|string` | Name of directory to list (overrides config.dir) |
| Param | Type | Desc |
| ----- | ------------------------- | ------------------------------------------------ |
| opts | `nil\|resession.ListOpts` | |
| >dir | `nil\|string` | Name of directory to list (overrides config.dir) |

### delete(name, opts)

`delete(name, opts)` \
Delete a saved session

| Param | Type | Desc | |
| ----- | --------------------------- | --------------------------------------------- | ------------------------------------------------------- |
| name | `nil\|string` | If not provided, prompt for session to delete | |
| opts | `nil\|resession.DeleteOpts` | | |
| | dir | `nil\|string` | Name of directory to delete from (overrides config.dir) |
| | notify | `nil\|boolean` | Notify on success (default true) |
| Param | Type | Desc |
| ------- | --------------------------- | ------------------------------------------------------- |
| name | `nil\|string` | If not provided, prompt for session to delete |
| opts | `nil\|resession.DeleteOpts` | |
| >dir | `nil\|string` | Name of directory to delete from (overrides config.dir) |
| >notify | `nil\|boolean` | Notify on success (default true) |

### save(name, opts)

`save(name, opts)` \
Save a session to disk

| Param | Type | Desc | |
| ----- | ------------------------- | -------------- | ---------------------------------------------------- |
| name | `nil\|string` | | |
| opts | `nil\|resession.SaveOpts` | | |
| | attach | `nil\|boolean` | Stay attached to session after saving (default true) |
| | notify | `nil\|boolean` | Notify on success (default true) |
| | dir | `nil\|string` | Name of directory to save to (overrides config.dir) |
| Param | Type | Desc |
| ------- | ------------------------- | ---------------------------------------------------- |
| name | `nil\|string` | |
| opts | `nil\|resession.SaveOpts` | |
| >attach | `nil\|boolean` | Stay attached to session after saving (default true) |
| >notify | `nil\|boolean` | Notify on success (default true) |
| >dir | `nil\|string` | Name of directory to save to (overrides config.dir) |

### save_tab(name, opts)

`save_tab(name, opts)` \
Save a tab-scoped session

| Param | Type | Desc | |
| ----- | ------------------------- | -------------------------------------------------- | ---------------------------------------------------- |
| name | `nil\|string` | If not provided, will prompt user for session name | |
| opts | `nil\|resession.SaveOpts` | | |
| | attach | `nil\|boolean` | Stay attached to session after saving (default true) |
| | notify | `nil\|boolean` | Notify on success |
| | dir | `nil\|string` | Name of directory to save to (overrides config.dir) |
| Param | Type | Desc |
| ------- | ------------------------- | ---------------------------------------------------- |
| name | `nil\|string` | If not provided, will prompt user for session name |
| opts | `nil\|resession.SaveOpts` | |
| >attach | `nil\|boolean` | Stay attached to session after saving (default true) |
| >notify | `nil\|boolean` | Notify on success (default true) |
| >dir | `nil\|string` | Name of directory to save to (overrides config.dir) |

### save_all(opts)

`save_all(opts)` \
Save all current sessions to disk

| Param | Type | Desc | |
| ----- | ---------------------------- | -------------- | ----------------- |
| opts | `nil\|resession.SaveAllOpts` | | |
| | notify | `nil\|boolean` | Notify on success |
| Param | Type | Desc |
| ------- | ---------------------------- | ----------------- |
| opts | `nil\|resession.SaveAllOpts` | |
| >notify | `nil\|boolean` | Notify on success |

### load(name, opts)

`load(name, opts)` \
Load a session

| Param | Type | Desc | |
| ----- | ------------------------- | ---------------------- | ------------------------------------------------------------ |
| name | `nil\|string` | | |
| opts | `nil\|resession.LoadOpts` | | |
| | attach | `nil\|boolean` | Stay attached to session after loading (default true) |
| | reset | `nil\|boolean\|"auto"` | Close everything before loading the session (default "auto") |
| | silence_errors | `nil\|boolean` | Don't error when trying to load a missing session |
| | dir | `nil\|string` | Name of directory to load from (overrides config.dir) |
| Param | Type | Desc |
| --------------- | ------------------------- | ------------------------------------------------------------ |
| name | `nil\|string` | |
| opts | `nil\|resession.LoadOpts` | |
| >attach | `nil\|boolean` | Stay attached to session after loading (default true) |
| >reset | `nil\|boolean\|"auto"` | Close everything before loading the session (default "auto") |
| >silence_errors | `nil\|boolean` | Don't error when trying to load a missing session |
| >dir | `nil\|string` | Name of directory to load from (overrides config.dir) |

**Note:**
<pre>
Expand Down
9 changes: 5 additions & 4 deletions doc/resession.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,9 @@ delete({name}, {opts}) *resession.delet
Parameters:
{name} `nil|string` If not provided, prompt for session to delete
{opts} `nil|resession.DeleteOpts`
{dir} `nil|string` Name of directory to delete from (overrides
config.dir)
{dir} `nil|string` Name of directory to delete from (overrides
config.dir)
{notify} `nil|boolean` Notify on success (default true)

save({name}, {opts}) *resession.save*
Save a session to disk
Expand All @@ -108,7 +109,7 @@ save({name}, {opts}) *resession.sav
{opts} `nil|resession.SaveOpts`
{attach} `nil|boolean` Stay attached to session after saving (default
true)
{notify} `nil|boolean` Notify on success
{notify} `nil|boolean` Notify on success (default true)
{dir} `nil|string` Name of directory to save to (overrides
config.dir)

Expand All @@ -120,7 +121,7 @@ save_tab({name}, {opts}) *resession.save_ta
{opts} `nil|resession.SaveOpts`
{attach} `nil|boolean` Stay attached to session after saving (default
true)
{notify} `nil|boolean` Notify on success
{notify} `nil|boolean` Notify on success (default true)
{dir} `nil|string` Name of directory to save to (overrides
config.dir)

Expand Down

0 comments on commit d3b6b36

Please sign in to comment.