chore(docs): migrate to asd-ste100 spec - #282
Merged
Merged
Conversation
Signed-off-by: Alan Brault <alan.brault@visus.io>
There was a problem hiding this comment.
Pull request overview
This PR migrates the library documentation and XML doc comments to ASD-STE100 (Simplified Technical English) to improve clarity and consistency across the public API and docs site.
Changes:
- Updates XML doc comments across core abstractions, services, validators, mappers, and integrations to use shorter, clearer sentences.
- Rephrases docs pages and shared include snippets under
docs/docs/to match the same style. - Documents the ASD-STE100 requirement in
AGENTS.mdfor ongoing enforcement.
Reviewed changes
Copilot reviewed 80 out of 80 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/Visus.AddressValidation/Validation/ValidationState.cs | XML doc wording adjustments for ASD-STE100. |
| src/Visus.AddressValidation/Validation/ValidationSeverity.cs | XML doc punctuation/style updates. |
| src/Visus.AddressValidation/Validation/IValidator.cs | Parameter doc wording updates. |
| src/Visus.AddressValidation/Validation/IBatchValidator.cs | Clarifies parameter semantics in XML docs. |
| src/Visus.AddressValidation/Validation/AbstractValidator.cs | Rephrases method docs for ASD-STE100. |
| src/Visus.AddressValidation/Validation/AbstractBatchValidator.cs | Rephrases method docs for ASD-STE100. |
| src/Visus.AddressValidation/Validation/AbstractAddressValidationRequestValidator.cs | Rewrites XML docs to shorter sentences. |
| src/Visus.AddressValidation/Services/IBatchAddressValidationService.cs | Updates batch interface docs for ASD-STE100. |
| src/Visus.AddressValidation/Services/IAddressValidationService.cs | Rewords interface docs (return/remarks wording changed). |
| src/Visus.AddressValidation/Services/AbstractBatchAddressValidationService.cs | Constructor/typeparam doc wording updates. |
| src/Visus.AddressValidation/Services/AbstractAuthenticationService.cs | Improves token caching docs readability. |
| src/Visus.AddressValidation/Services/AbstractAddressValidationService.cs | Constructor/typeparam doc wording updates. |
| src/Visus.AddressValidation/Serialization/Json/TokenResponseConverter.cs | Updates converter remarks/summary wording. |
| src/Visus.AddressValidation/Models/IAddressValidationResponse.cs | XML doc clarity/punctuation updates. |
| src/Visus.AddressValidation/Models/EmptyAddressValidationResponse.cs | Clarifies ctor parameter docs. |
| src/Visus.AddressValidation/Models/AbstractAddressValidationResponse.cs | Clarifies ctor/typeparam docs and terminology. |
| src/Visus.AddressValidation/Models/AbstractAddressValidationRequest.cs | Rephrases property docs and remarks. |
| src/Visus.AddressValidation/Mappers/IBatchApiResponseMapper.cs | Clarifies mapper parameter docs. |
| src/Visus.AddressValidation/Mappers/IBatchApiRequestMapper.cs | Clarifies request ordering docs. |
| src/Visus.AddressValidation/Mappers/IApiResponseMapper.cs | Clarifies mapper parameter docs. |
| src/Visus.AddressValidation/InvalidImplementationException.cs | Updates exception summary wording. |
| src/Visus.AddressValidation/Http/TokenResponse.cs | Rephrases record parameter docs. |
| src/Visus.AddressValidation/Http/Clients/IAuthenticationClient.cs | Updates interface docs wording. |
| src/Visus.AddressValidation/Http/Clients/AbstractClientCredentialsAuthenticationClient.cs | Rephrases UseHttpBasicAuthentication docs. |
| src/Visus.AddressValidation/Http/BearerTokenDelegatingHandler.cs | Clarifies XML docs and exception text. |
| src/Visus.AddressValidation/Http/BasicAuthenticationHeaderValue.cs | Improves summary wording. |
| src/Visus.AddressValidation/Extensions/HttpClientBuilderExtensions.cs | Rewrites resilience handler docs to ASD-STE100. |
| src/Visus.AddressValidation/Extensions/DictionaryExtensions.cs | Clarifies merge behavior remarks. |
| src/Visus.AddressValidation/CustomResponseDataPropertyAttribute.cs | Rephrases attribute docs and Name semantics. |
| src/Visus.AddressValidation/Configuration/AbstractServiceOptions.cs | Rewrites options docs/remarks to ASD-STE100. |
| src/Visus.AddressValidation/Adapters/IBatchApiRequestAdapter.cs | Clarifies ordering/return semantics wording. |
| src/Visus.AddressValidation/Adapters/IApiRequestAdapter.cs | Clarifies adapter semantics and cancellation param docs. |
| src/Visus.AddressValidation/Abstractions/CountryCode.cs | XML doc punctuation/style update. |
| src/Visus.AddressValidation/Abstractions/ClientEnvironment.cs | XML doc punctuation/style update. |
| src/Visus.AddressValidation.SourceGeneration/SyntaxGenerationHelpers.cs | Rephrases generator helper docs. |
| src/Visus.AddressValidation.SourceGeneration/StringHelpers.cs | Rephrases helper docs and return descriptions. |
| src/Visus.AddressValidation.SourceGeneration/PropertyInfo.cs | Rephrases metadata record docs. |
| src/Visus.AddressValidation.SourceGeneration/CustomResponseDataGenerator.cs | Rewrites generator summary/remarks. |
| src/Visus.AddressValidation.SourceGeneration/ContainingTypeInfo.cs | Rephrases type metadata docs. |
| src/Visus.AddressValidation.Integration.Ups/Models/UpsAddressValidationRequest.cs | Rephrases model docs. |
| src/Visus.AddressValidation.Integration.Ups/Extensions/ServiceCollectionExtensions.cs | Rephrases DI extension docs. |
| src/Visus.AddressValidation.Integration.Ups/Constants.cs | Rephrases integration constants docs. |
| src/Visus.AddressValidation.Integration.Ups/Configuration/UpsServiceOptions.cs | Rephrases options constant docs. |
| src/Visus.AddressValidation.Integration.PitneyBowes/Models/PitneyBowesAddressValidationRequest.cs | Rephrases model docs/remarks. |
| src/Visus.AddressValidation.Integration.PitneyBowes/Extensions/ServiceCollectionExtensions.cs | Rephrases DI extension docs. |
| src/Visus.AddressValidation.Integration.PitneyBowes/Constants.cs | Rephrases integration constants docs. |
| src/Visus.AddressValidation.Integration.PitneyBowes/Configuration/PitneyBowesServiceOptions.cs | Rephrases options constant docs. |
| src/Visus.AddressValidation.Integration.Google/Models/GoogleAddressValidationRequest.cs | Rephrases model docs/remarks. |
| src/Visus.AddressValidation.Integration.Google/Extensions/ServiceCollectionExtensions.cs | Rephrases DI extension docs. |
| src/Visus.AddressValidation.Integration.Google/Constants.cs | Rephrases integration constants docs. |
| src/Visus.AddressValidation.Integration.Google/Configuration/GoogleServiceOptions.cs | Rephrases options docs/remarks. |
| src/Visus.AddressValidation.Integration.FedEx/Models/FedExAddressValidationRequest.cs | Rephrases model docs/remarks. |
| src/Visus.AddressValidation.Integration.FedEx/Extensions/ServiceCollectionExtensions.cs | Rephrases DI extension docs. |
| src/Visus.AddressValidation.Integration.FedEx/Constants.cs | Rephrases integration constants docs. |
| src/Visus.AddressValidation.Integration.FedEx/Configuration/FedExServiceOptions.cs | Rephrases options docs/remarks. |
| src/Visus.AddressValidation.Integration.FedEx/Abstractions/ResolutionMethod.cs | Updates enum member summaries for clarity. |
| src/Visus.AddressValidation.Integration.FedEx/Abstractions/AddressType.cs | Updates enum member summary wording. |
| src/Visus.AddressValidation.Integration.FedEx/Abstractions/AddressClassification.cs | Updates enum member summary wording. |
| README.md | Rephrases README narrative sections to ASD-STE100. |
| docs/docs/integrations/ups.md | Rewrites UPS integration page to ASD-STE100. |
| docs/docs/integrations/pitney-bowes.md | Rewrites Pitney Bowes integration page to ASD-STE100. |
| docs/docs/integrations/google.md | Rewrites Google integration page to ASD-STE100. |
| docs/docs/integrations/fedex.md | Rewrites FedEx integration page to ASD-STE100. |
| docs/docs/integrations/custom/validators.md | Rewrites custom validator docs to ASD-STE100. |
| docs/docs/integrations/custom/validation-client.md | Rewrites custom validation client docs to ASD-STE100. |
| docs/docs/integrations/custom/registering-services.md | Rewrites service registration docs to ASD-STE100. |
| docs/docs/integrations/custom/models.md | Rewrites custom model docs to ASD-STE100. |
| docs/docs/integrations/custom/mappers.md | Rewrites mapper docs to ASD-STE100. |
| docs/docs/integrations/custom/introduction.md | Rewrites custom integration intro to ASD-STE100. |
| docs/docs/integrations/custom/batch-validators.md | Rewrites batch validator docs to ASD-STE100. |
| docs/docs/integrations/custom/batch-validation-client.md | Rewrites batch client docs to ASD-STE100. |
| docs/docs/integrations/custom/batch-mappers.md | Rewrites batch mapper docs to ASD-STE100. |
| docs/docs/integrations/custom/authentication.md | Rewrites authentication docs to ASD-STE100. |
| docs/docs/instrumentation.md | Rephrases instrumentation docs and activity descriptions. |
| docs/docs/index.md | Rewrites main docs index page narrative sections. |
| docs/docs/includes/suggestions-need-validation-note.md | Rewrites shared warning include text. |
| docs/docs/includes/is-residential-note.md | Rewrites shared warning include text. |
| docs/docs/includes/internal-validation-note.md | Rewrites shared note include text. |
| docs/docs/includes/hybrid-cache-required.md | Rewrites shared important include text. |
| AGENTS.md | Adds ASD-STE100 documentation-style requirement to contributor guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Signed-off-by: Alan Brault <alan.brault@visus.io>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 80 out of 80 changed files in this pull request and generated no new comments.
Suppressed comments (3)
src/Visus.AddressValidation.SourceGeneration/StringHelpers.cs:24
- The
ToSafeFileNamesummary says it replaces characters that file systems reject, but the implementation only replaces.,<, and>(and removesglobal::). This overstates the behavior and implies.is invalid on file systems.
src/Visus.AddressValidation/Adapters/IBatchApiRequestAdapter.cs:27 - The
<remarks>impliesTApiResponseis a collection by saying “each TApiResponse item”.TApiResponseis the batch response object (genericclass), so this wording is misleading. Refer to items within the response instead.
src/Visus.AddressValidation.SourceGeneration/StringHelpers.cs:15 ToCamelCasereturns the input unchanged when it is null, empty, or whitespace (string.IsNullOrWhiteSpace). The updated<returns>doc only mentions null/empty, so it is now inaccurate.
This issue also appears on line 23 of the same file.
Signed-off-by: Alan Brault <alan.brault@visus.io>
|
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 80 out of 80 changed files in this pull request and generated no new comments.
Suppressed comments (1)
src/Visus.AddressValidation/InvalidImplementationException.cs:5
- The XML summary is too narrow for how this exception is used. It is also thrown when an implementation violates other required contracts (for example, when a batch validator returns the wrong number of results), not only when a type fails to derive from a base class. Update the summary so it covers contract violations in general.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.