Skip to content

Release Tracker Analyzer RS2007 Does Not Support Table Borders #7465

Open
@Thomas-Shephard

Description

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions