Skip to content

Commit

Permalink
docs(generated): update doc/rocks.txt
Browse files Browse the repository at this point in the history
skip-checks: true
  • Loading branch information
Github Actions authored and vhyrro committed Dec 12, 2023
1 parent 0d79098 commit 2d36277
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions doc/rocks.txt
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,20 @@ api.query_installed_rocks({callback}) *api.query_installed_rocks*
{callback} (fun(rocks:table<rock_name,Rock>)) @async


api.get_rocks_toml() *api.get_rocks_toml*
api.get_rocks_toml_path() *api.get_rocks_toml_path*
Gets the rocks.toml file path.
Note that the file may not have been created yet.

Returns: ~
(string) rocks_toml_file
(string) rocks_toml_file_path


api.get_rocks_toml() *api.get_rocks_toml*
Returns a table with the parsed rocks.toml file.
If the file doesn't exist a file with the default configuration will be created.

Returns: ~
(table) rocks_toml_file


RocksCmd *RocksCmd*
Expand Down

0 comments on commit 2d36277

Please sign in to comment.