PowerShell / PowerShell/PSScriptAnalyzer
Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- C#
- Estrelas
- 2.2k
- Forks
- 415
- Merge médio
- 13h 1min
- PRs com merge (30d)
- 2
Descrição
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
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Abra RuleDocumentation/AvoidTrailingWhitespace.md e revise a explicação citada sobre espaços em branco no final da linha e o caractere backtick. Decida qual das três alterações de redação corresponde melhor às diretrizes de documentação do projeto, atualize essa passagem e verifique se ela descreve a prática com precisão sem tratar backticks como caracteres de continuação de linha.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- powershell
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 1/5
- Tempo estimado
- Menos de uma hora
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100