PowerShell / PowerShell/PSScriptAnalyzer

Documentation for AvoidTrailingWhitespace shouldn't use bad practices for reasoning

Đang mở
#1,034 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Area - Documentation Issue - Discussion
Ngôn ngữ chính
C#
Star
2.2k
Fork
415
Merge trung bình
13 giờ 1 phút
Pull request đã merge (30 ngày)
2

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Mở RuleDocumentation/AvoidTrailingWhitespace.md và xem lại phần giải thích được trích dẫn về khoảng trắng ở cuối dòng và ký tự backtick. Quyết định thay đổi cách diễn đạt nào trong ba thay đổi phù hợp nhất với hướng dẫn tài liệu của dự án, cập nhật đoạn đó và xác minh rằng đoạn đó mô tả chính xác thực hành này mà không coi backtick là ký tự tiếp tục dòng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
powershell
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.