canonical / canonical/documentation-style-guide

The dollar sign used to indicate a variable is incorrectly flagged as a prompt in a code block

Open
#92 4 comments 0 reactions 0 assignees View on GitHub
Priority: Low Type: bug
Dominant language
Python
Stars
22
Forks
41
PR merge metrics
No merged PRs in 30d

Description

A $ sign preceded by " might often indicate a variable rather than a command prompt.

For example:

```
export PATH="$PATH:/home/user/snap/multipass/common/bin"
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the Vale rule that flags dollar signs as command prompts and reproduce the warning with the provided export PATH example. Check the rule's existing tests or fixtures, then verify that a dollar sign inside a quoted variable assignment is accepted while the intended prompt cases remain flagged.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.