diff options
| author | William Boman <william@redwill.se> | 2022-08-06 14:23:10 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-06 14:23:10 +0200 |
| commit | efd190d5c47be43ccc4e8ef81faa13c5d8b6508e (patch) | |
| tree | fed23f7f8ac3928463379f1f3df70c9708184826 /doc | |
| parent | feat: add buildifier, blade-formatter, blue, haml-lint, textlint, vulture, cf... (diff) | |
| download | mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.gz mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.bz2 mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.lz mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.xz mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.tar.zst mason-efd190d5c47be43ccc4e8ef81faa13c5d8b6508e.zip | |
docs: add :help mason.nvim to README (#259)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mason.txt | 21 |
1 files changed, 11 insertions, 10 deletions
diff --git a/doc/mason.txt b/doc/mason.txt index d174791f..14f5e8b7 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -3,6 +3,7 @@ Minimum version of neovim: 0.7.0 Author: William Boman + Type |gO| to see the table of contents. ============================================================================== INTRODUCTION *mason-introduction* @@ -17,10 +18,10 @@ linked to a single `bin/` directory, which `mason.nvim` will add to the Neovim's PATH during setup, allowing easy access for the builtin shell/terminal as well as other 3rd party plugins. -API reference: ~ +API reference: https://github.com/williamboman/mason.nvim/blob/main/doc/reference.md -Extensions: ~ +Extensions: - https://github.com/williamboman/mason-lspconfig.nvim ============================================================================== @@ -277,10 +278,10 @@ is_installed({package_name}) this is a more efficient option than the Package:is_installed() method due to a smaller amount of modules required to load. - Parameters: ~ + Parameters: {package_name} - string - Returns: ~ + Returns: boolean *mason-registry.get_package()* @@ -290,10 +291,10 @@ get_package({package_name}) This function errors if a package cannot be found. - Parameters: ~ + Parameters: {package_name} - string - Returns: ~ + Returns: Package *mason-registry.get_installed_packages()* @@ -301,7 +302,7 @@ get_installed_packages() Returns all installed package instances. This is a slower function that loads more modules. - Returns: ~ + Returns: Package[] *mason-registry.get_installed_package_names()* @@ -309,7 +310,7 @@ get_installed_package_names() Returns all installed package names. This is a fast function that doesn't load any extra modules. - Returns: ~ + Returns: string[] *mason-registry.get_all_packages()* @@ -317,7 +318,7 @@ get_all_packages() Returns all package instances. This is a slower function that loads more modules. - Returns: ~ + Returns: Package[] *mason-registry.get_all_package_names()* @@ -325,7 +326,7 @@ get_all_package_names() Returns all package names. This is a fast function that doesn't load any extra modules. - Returns: ~ + Returns: string[] |