fix: Re-enable SA1615 return value documentation rule (#14)#86
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR re-enables several StyleCop XML documentation rules (notably SA1615) and updates repository guidance/configuration so return value documentation is consistently present and enforced going forward.
Changes:
- Re-enabled SA1615/SA1623/SA1629 in
.editorconfigaswarning. - Updated Copilot contributor guidance to require
<returns>tags on public APIs. - Added/adjusted XML doc comments across server code and introduced
.gitattributesto enforce LF endings.
Reviewed changes
Copilot reviewed 24 out of 24 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Server/Services/Connections/DirectClientConnection.cs | Updates property XML docs to SA1623-compliant “Gets or sets …” wording. |
| Server/Services/Connections/ConnectionsConfig.cs | Updates property XML docs to SA1623-compliant wording. |
| Server/Services/CompilationService.cs | Adds <returns> documentation to multiple methods to satisfy SA1615. |
| Server/Services/CodeLens/CodeLensConfig.cs | Updates property XML docs to SA1623-compliant wording. |
| Server/Services/Api/ApiServiceConfig.cs | Updates read-only property summary to “Gets …” wording. |
| Server/SdkIndex.cs | Adds <returns> documentation for several public/internal APIs (incl. async factory). |
| Server/LogSanitizer.cs | Adds <returns> documentation for SanitizeUrl. |
| Server/Handlers/HoverHandler/SdkDynamicOperationsDiscovery.cs | Adds <returns> documentation for config fallback lookup. |
| Server/Handlers/HoverHandler/HoverHandlerTypes.cs | Adjusts XML doc punctuation to satisfy SA1629. |
| Server/Handlers/CompletionHandler/CompletionHandler.cs | Adds <returns> documentation for helper methods returning nullable strings. |
| Server/Handlers/CodeActionHandler/SchemaToClassGenerator.cs | Adds <returns> documentation for generator helpers. |
| Server/Handlers/CodeActionHandler/GenerateDynamicSchemaCommandHandler.cs | Adds <returns> documentation for source-update helper. |
| Server/Handlers/CodeActionHandler/DynamicSchemaCodeActionHandler.cs | Adds <returns> documentation for detection/name generation helpers. |
| Server/Handlers/CodeActionHandler/DynamicSchemaCache.cs | Adds <returns> documentation for cache build/scan methods. |
| Server/ExceptionExtensions.cs | Adds <returns> documentation for IsFatal. |
| Server/DynamicValuesHelper.cs | Adds <returns> documentation for helper methods. |
| Server/Diagnostics/Validators/ValidatorHelpers.cs | Adds <returns> documentation for validator helper utilities. |
| Server/Diagnostics/LevenshteinDistance.cs | Adds <returns> documentation for Compute. |
| Server/Diagnostics/IDiagnosticValidator.cs | Adds <returns> documentation for the validator async contract. |
| Server/Diagnostics/DiagnosticPublisher.cs | Adds <returns> documentation for async publish method. |
| Server/BufferManager.cs | Adds <returns> documentation for buffer snapshot accessor. |
| .github/copilot-instructions.md | Updates contributor guidance to require <returns> tags. |
| .gitattributes | Adds LF line-ending enforcement to match .editorconfig. |
| .editorconfig | Re-enables SA1615/SA1623/SA1629 as warnings. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Re-enables StyleCop SA1615 (return value documentation) as a warning to prevent regression, now that all public methods have <returns>\ tags from prior PRs. Also promotes SA1623 and SA1629 to warning (zero violations exist).
Changes
Verification
Closes #14