diff options
Diffstat (limited to 'doc/reference.md')
| -rw-r--r-- | doc/reference.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/reference.md b/doc/reference.md index d1349ab7..8caa4134 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -1,5 +1,11 @@ # Mason API reference +This document contains the API reference for `mason.nvim`'s' public APIs. +The intended audience of this document are plugin developers and people who want to further customize their own Neovim +configuration. + +Note that APIs not listed in this document are not considered public, and are subject to unannounced, breaking, changes. + - [Architecture diagram](#architecture-diagram) - [`PackageSpec`](#packagespec) - [`Package`](#package) @@ -30,10 +36,6 @@ - [`EventEmitter:once({event, handler})`](#eventemitteronceevent-handler) - [`EventEmitter:off({event}, {handler})`](#eventemitteroffevent-handler) -This document contains the API reference for `mason.nvim`'s' public APIs. -The intended audience of this document are plugin developers and people who want to further customize their own Neovim -configuration. - ## Architecture diagram  @@ -54,6 +56,8 @@ configuration. ## `Package` +Module: [`"mason-core.package"`](../lua/mason-core/package/init.lua) + The `Package` class encapsulates the installation instructions and metadata about a Mason package. **Events** |