Problem
The .editorconfig suppresses SA1615 (element return value should be documented) and the .github/copilot-instructions.md says "Do NOT document return values". This convention is inherited from the internal BPM repo and is inappropriate for a public repository where XML docs surface in IntelliSense.
Proposed Changes
- Update
.github/copilot-instructions.md to remove the "Do NOT document return values" rule
- Remove the
dotnet_diagnostic.SA1615.severity = none suppression from .editorconfig
- Add
<returns> tags to all public methods that currently lack them
- Review SA1623 (property summary wording) and SA1629 (doc ending with period) suppressions — re-enable if practical
Context
SA1615 was suppressed in the compliance PR (#13) because 15+ methods lacked return value docs. This issue tracks the proper fix: adding the docs rather than suppressing the rule.
See also: Azure/Connectors-NET-SDK#41
Problem
The
.editorconfigsuppresses SA1615 (element return value should be documented) and the.github/copilot-instructions.mdsays "Do NOT document return values". This convention is inherited from the internal BPM repo and is inappropriate for a public repository where XML docs surface in IntelliSense.Proposed Changes
.github/copilot-instructions.mdto remove the "Do NOT document return values" ruledotnet_diagnostic.SA1615.severity = nonesuppression from.editorconfig<returns>tags to all public methods that currently lack themContext
SA1615 was suppressed in the compliance PR (#13) because 15+ methods lacked return value docs. This issue tracks the proper fix: adding the docs rather than suppressing the rule.
See also: Azure/Connectors-NET-SDK#41