Skip to content

Comments

Fix awkward sentences in comments#1650

Merged
bart-vmware merged 3 commits intomainfrom
fix-grammar-in-comments
Feb 5, 2026
Merged

Fix awkward sentences in comments#1650
bart-vmware merged 3 commits intomainfrom
fix-grammar-in-comments

Conversation

@bart-vmware
Copy link
Member

No description provided.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request fixes awkward grammar in XML documentation comments across multiple files by correcting the non-idiomatic "Enables to [verb]" construction to the more natural "Enables [verb]ing" form.

Changes:

  • Updated XML documentation comments to use proper English grammar by changing "Enables to" constructions to "Enables [gerund]" across 10 files
  • Fixed comments in production code (Management, Logging, Discovery, Configuration, Common) and test utilities

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
IEndpointOptionsMonitorProvider.cs Fixed "Enables to register" to "Enables registering" in interface documentation
SerilogOptions.cs Fixed two method parameter descriptions: "Enables to bind" and "Enables to configure"
SerilogLoggingBuilderExtensions.cs Fixed two parameter descriptions for Serilog configuration methods
DynamicLoggerProvider.cs Fixed class-level documentation for decorator functionality
DynamicPortAssignmentHostedService.cs Fixed inner class documentation for options change triggering
ConfigServerConfigurationBuilderExtensions.cs Fixed parameter description for Config Server configuration
TestFailureTracer.cs Fixed class-level documentation for test failure logging
EnvironmentVariableScope.cs Fixed class-level documentation for environment variable testing utility
CapturingLoggerProvider.cs Fixed class-level documentation for test logger
BootstrapLoggerFactory.cs Fixed two parameter descriptions for bootstrap logger configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 5, 2026

Summary - All Code Coverage (ubuntu-latest)

Line coverage Branch coverage

Assembly Line coverage Branch coverage
Steeltoe.Bootstrap.AutoConfiguration 97.4% 100%
Steeltoe.Common 84.3% 78.6%
Steeltoe.Common.Certificates 96.2% 85.5%
Steeltoe.Common.Hosting 84% 70%
Steeltoe.Common.Http 100% 85.2%
Steeltoe.Common.Logging 81.1% 56.2%
Steeltoe.Common.Net 64.5% 66.6%
Steeltoe.Configuration.Abstractions 98.5% 91.1%
Steeltoe.Configuration.CloudFoundry 99.1% 91.8%
Steeltoe.Configuration.ConfigServer 97.2% 91.6%
Steeltoe.Configuration.Encryption 97.6% 92.4%
Steeltoe.Configuration.Kubernetes.ServiceBindings 95.1% 89.3%
Steeltoe.Configuration.Placeholder 93.8% 84.7%
Steeltoe.Configuration.RandomValue 93.2% 90%
Steeltoe.Configuration.SpringBoot 98.3% 95%
Steeltoe.Connectors 93.9% 89.8%
Steeltoe.Connectors.EntityFrameworkCore 81.5% 75%
Steeltoe.Discovery.Configuration 92.3% 100%
Steeltoe.Discovery.Consul 97.6% 96.1%
Steeltoe.Discovery.Eureka 91.8% 85.2%
Steeltoe.Discovery.HttpClients 94.2% 95.4%
Steeltoe.Logging.Abstractions 99.4% 96.9%
Steeltoe.Logging.DynamicConsole 100% 95.4%
Steeltoe.Logging.DynamicSerilog 99.1% 95.4%
Steeltoe.Management.Abstractions 100% 100%
Steeltoe.Management.Endpoint 95.6% 89.1%
Steeltoe.Management.Prometheus 95.9% 91.6%
Steeltoe.Management.Tasks 100% ****
Steeltoe.Management.Tracing 100% 75%
Steeltoe.Security.Authentication.JwtBearer 100% 100%
Steeltoe.Security.Authentication.OpenIdConnect 73.8% 59%
Steeltoe.Security.Authorization.Certificate 96.3% 75%
Steeltoe.Security.DataProtection.Redis 100% ****

bart-vmware and others added 2 commits February 5, 2026 14:50
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 5, 2026

@bart-vmware bart-vmware marked this pull request as ready for review February 5, 2026 14:57
@bart-vmware bart-vmware requested a review from TimHess February 5, 2026 14:57
@bart-vmware bart-vmware merged commit fbe5079 into main Feb 5, 2026
24 of 25 checks passed
@bart-vmware bart-vmware deleted the fix-grammar-in-comments branch February 5, 2026 15:16
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 this pull request may close these issues.

2 participants