PowerShell / PowerShell/PSScriptAnalyzer
Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 2.2k
- Fork
- 414
- Merge medio
- 13h 1m
- PR unite (30g)
- 2
Descrizione
from document file /RuleDocumentation/AvoidTrailingWhitespace.md:
Lines should not end with whitespace characters. This can cause problems with the line-continuation backtick, and also clutters up future commits to source control.
The backtick character is not a "line-continuation" character and using it as such is generally considered bad practice (for the exact reason noted in this document). I feel this shouldn't be listed as a reason for avoiding trailing whitespace since it's saying you should avoid one bad practice to prevent messing with another bad practice.
I feel this should be changed to either:
- Not refer to the backtick character as a "line-continuation character" since that's not what it is and call out this use as bad practice
- Explicitly call out that the use of the backtick character as a "line-continuation character" is considered bad practice
- Remove the reference to the use of the backtick character in the description entirely, since this usage should be avoided in the first place
What is the latest version of PSScriptAnalyzer at the point of writing
1.17.1
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Apri RuleDocumentation/AvoidTrailingWhitespace.md e rivedi la spiegazione citata sugli spazi bianchi finali e sul carattere backtick. Decidi quale delle tre modifiche alla formulazione corrisponde meglio alle linee guida della documentazione del progetto, aggiorna quel passaggio e verifica che descriva accuratamente la pratica senza trattare i backtick come caratteri di continuazione di riga.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- powershell
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100