Skip to content

Commit

Permalink
docs: remove version from plugin documentation howto
Browse files Browse the repository at this point in the history
Put a note that it may be useful to include in app-specific plugins
  • Loading branch information
lengau committed Aug 28, 2024
1 parent 8b0d76c commit 4b8a84a
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions docs/how-to/document-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,13 @@ headings and main text.

<name>
The name of the plugin; e.g. Python
<version>
The version of the library or tool that provides the plugin; e.g. Snapcraft 8.0.

Replace the instructions with suitable descriptions.


<Name> plugin
-------------

**Version**: <version>

A general description of the plugin that includes as many of these items as
necessary:

Expand All @@ -31,6 +27,9 @@ necessary:
It is also useful to indicate if the plugin replaces an existing plugin, or
should be used instead of another similar plugin.

If documenting an application-specific plugin, it may be appropriate to include
the version of the application in which this plugin first appears here.


Keywords
~~~~~~~~
Expand Down

0 comments on commit 4b8a84a

Please sign in to comment.