Consideration of markdownlint's rule MD014 #1507
Unanswered
haydenseitz
asked this question in
Questions
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
First Check
Commit to Help
Example Code
Description
I am getting a linting error from markdownlint on the generated docs via
typer <entrypoint> utils docs. MD014 recommends not prepending shell commands with$unless output is also displayed.I confirmed that this is implemented in Typer here (not from Click).
I can disable the linting rule, but I'd like to get consideration from maintainers/community if default behavior should be to not include leading
$for the example commands.Operating System
Linux
Operating System Details
No response
Typer Version
master
Python Version
3.13
Additional Context
No response
Beta Was this translation helpful? Give feedback.
All reactions