Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release Tracker Analyzer RS2007 Does Not Support Table Borders #7465

Open
Thomas-Shephard opened this issue Nov 3, 2024 · 0 comments · May be fixed by #7466
Open

Release Tracker Analyzer RS2007 Does Not Support Table Borders #7465

Thomas-Shephard opened this issue Nov 3, 2024 · 0 comments · May be fixed by #7466

Comments

@Thomas-Shephard
Copy link

Analyzer

Diagnostic ID: RS2007: Invalid entry in analyzer release file

Analyzer source

NuGet Package: Microsoft.CodeAnalysis.Analyzers

Version: 3.11.0

Also tested in main d6e7d82

Describe the bug

For compatibility reasons, all table rows should have borders (pipe symbols) at the start and at the end. However, the RS2007 analyzer does not permit borders at the start or at the end of lines and raises the warning if they are provided.

Steps To Reproduce

Update the borders of a new rule or changed rule table to include a start or end border.

Example

The following is accepted (in main although not in the latest release 3.11.0)

Rule ID | Category      | Severity | Notes
--------|---------------|----------|---------------------------------------------------------
DCA0001 | Documentation | Warning  | TypeDeclarationMissingDocumentationCommentAnalyzer
DCA0002 | Documentation | Warning  | EnumMemberDeclarationMissingDocumentationCommentAnalyzer

but the following causes an issue because of the border

| Rule ID | Category      | Severity | Notes                                                    |
|---------|---------------|----------|----------------------------------------------------------|
| DCA0001 | Documentation | Warning  | TypeDeclarationMissingDocumentationCommentAnalyzer       |
| DCA0002 | Documentation | Warning  | EnumMemberDeclarationMissingDocumentationCommentAnalyzer |

Expected behavior

Allows for table tables to have included borders.

Actual behavior

Breaks best practice for compatibility by producing a warning when table borders are included.

Additional context

Previously mentioned in a comment as part of a similar issue.

@Thomas-Shephard Thomas-Shephard linked a pull request Nov 3, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant