PowerShell / PowerShell/PSScriptAnalyzer
Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning
Personne n'a encore pris cette issue.
- Langage dominant
- C#
- Étoiles
- 2.2k
- Forks
- 414
- Merge moyen
- 13 h 1 min
- PR mergées (30 j)
- 2
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Ouvrez RuleDocumentation/AvoidTrailingWhitespace.md et examinez l’explication citée concernant les espaces blancs en fin de ligne et le caractère backtick. Déterminez laquelle des trois modifications de formulation correspond le mieux aux directives de documentation du projet, mettez à jour ce passage et vérifiez qu’il décrit correctement la pratique sans traiter les backticks comme des caractères de continuation de ligne.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- powershell
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100