PowerShell / PowerShell/PSScriptAnalyzer
Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning
還沒有人認領這個 Issue。
- 主要語言
- C#
- 星號
- 2.2k
- 分支
- 415
- 平均合併
- 13 小時 1 分鐘
- 30 天內合併 PR
- 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:
- 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
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
開啟 RuleDocumentation/AvoidTrailingWhitespace.md,檢視其中關於行尾空白與反引號字元的引用說明。決定三種措辭變更中哪一種最符合專案的文件指引,更新該段內容,並確認其準確描述了這項實務,且不會將反引號視為行延續字元。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- powershell
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 1/5
- 預估耗時
- 1 小時以內
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100