dotnet/roslyn

`IsPreprocessorKeyword` documentation comment doesn't match implementation

Open

#54,604 opened on Jul 4, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (4,257 forks)batch import
Area-CompilersBughelp wanted

Repository metrics

Stars
 (20,414 stars)
PR merge metrics
 (Avg merge 6d 17h) (256 merged PRs in 30d)

Description

https://github.com/dotnet/roslyn/blob/43afd6dfd4b79380ff48078dfb264c60c518948c/src/Workspaces/SharedUtilitiesAndExtensions/Compiler/Core/Services/SyntaxFacts/ISyntaxFacts.cs#L81-L85

The documentation says: "The set of identifiers that have special meaning directly after the # token". However, the implementation delegates to the following:

https://github.com/dotnet/roslyn/blob/43afd6dfd4b79380ff48078dfb264c60c518948c/src/Compilers/CSharp/Portable/Syntax/SyntaxKindFacts.cs#L68-L101

which returns true for things that, as far as I know, doesn't come "directly after" the # (for example TrueKeyword).

Contributor guide

Research direction
Compare the documentation comment in ISyntaxFacts.cs with the implementation in SyntaxKindFacts.cs to identify discrepancies. Update the documentation or implementation to align.
Tech stack
csharp
Domain
compilers
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90