PowerShell / PowerShell/PSScriptAnalyzer

Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning

オープン
#1,034 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Area - Documentation Issue - Discussion
主要言語
C#
スター
2.2k
フォーク
414
平均マージ
13時間 1分
マージ済み PR(30日)
2

説明

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:

  1. 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
  2. Explicitly call out that the use of the backtick character as a "line-continuation character" is considered bad practice
  3. 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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

RuleDocumentation/AvoidTrailingWhitespace.md を開き、末尾の空白とバッククォート文字についての引用された説明を確認してください。3 つの文言変更のうち、プロジェクトのドキュメントガイダンスに最も合うものを決定し、その箇所を更新して、バッククォートを行継続文字として扱わずにその慣行を正確に説明していることを確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
powershell
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。