Skip to content

Commit 251b69e

Browse files
committed
docs: changes as requested
Signed-off-by: Soumyadeep Ghosh <[email protected]>
1 parent f1a795d commit 251b69e

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

docs/how-to/debugging/use-the-metadata-linter.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ Use the metadata linter
55

66
The following guidelines describe how to address issues flagged by the metadata linter.
77

8-
To resolve a missing metadata field, add the missing field to the snap's
9-
``snapcraft.yaml`` file.
8+
To resolve a missing metadata key, add it to the snap's project file.
109

11-
Currently these following metadata fields are linted:
10+
The following metadata keys are linted:
1211

1312
- ``title``
1413
- ``contact``
@@ -20,4 +19,6 @@ Currently these following metadata fields are linted:
2019

2120
See the :ref:`reference-snapcraft-yaml-top-level-keys` for more information about these keys.
2221

23-
To ignore the metadata field, add the field to the ``lint.ignore.metadata`` key. See :ref:`how-to-disable-a-linter-ignore-specific-keys-of-metadata-linter` for more information.
22+
To ignore a key, add it to the ``lint.ignore.metadata`` key.
23+
24+
See :ref:`how-to-disable-a-linter-ignore-specific-keys-of-metadata-linter` for more information.

docs/reference/linters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,4 @@ Snapcraft runs the following linters:
2323
dependencies, such as libraries, are missing, and that no extra libraries are included
2424
in the snap package.
2525
- :ref:`Metadata <how-to-use-the-metadata-linter>`. Verifies that the snap contains all the
26-
:ref:`metadata <reference-anatomy-of-snapcraft-yaml>` needed for a better listing in the snap store.
26+
:ref:`metadata <reference-anatomy-of-snapcraft-yaml-metadata>` needed for a better listing in the snap store.

docs/reference/project-file/anatomy-of-snapcraft-yaml.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ Several :ref:`top-level keys <reference-snapcraft-yaml-top-level-keys>` define a
3636
describe the snap.
3737

3838

39+
.. _reference-anatomy-of-snapcraft-yaml-metadata:
40+
3941
Metadata
4042
^^^^^^^^
4143

0 commit comments

Comments
 (0)