canonical / canonical/sphinx-stack

Strings in code block are not ignored by Vale spelling check

Open
#421 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
37
Forks
77
Avg merge
1d 5h
Merged PRs (30d)
3

Description

In the following code snippet, the example command contains the control character `\n` in the input string. Vale spelling check reported errors on the words concatenated with the preceding character `n`.

Because it's within a code block, the `:vale-ignore:` custom role cannot be used (If used, the error is gone, but the role will be rendered as text). The error can be suppressed by adding the reported string to the custom wordlist, but they should not be accepted words.

```rst
.. code-block:: none

id: network_iface_info
_summary: Fetches information of all network intefaces
plugin: resource
command:
ip -details -json link show | jq -r '
.[] | "interface: " + .ifname +
"\nlink_info_kind: " + .linkinfo.info_kind +
"\nlink_type: " + .link_type +
"\noperstate: " + .operstate + "\n"'
```

```
error The word 'nlink_info_kind' seems to Canonical.000-US-spellcheck misspelled.
error The word 'nlink_type' seems to Canonical.000-US-spellcheck misspelled.
error The word 'noperstate' seems to Canonical.000-US-spellcheck misspelled.
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.