Skip to content

docs: fix typos in comments, XML docs and messages - #63

Open
Avicennasis wants to merge 1 commit into
allegro:mainfrom
Avicennasis:docs/fix-typos
Open

Avicennasis wants to merge 1 commit into
allegro:mainfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix 15 typos across 9 files, each verified against current main. Almost all are XML doc comments / inline comments; two touch message strings (called out below).

Comments and XML docs

  • DependencyCall.cs: <param name="request">Data send to dependency</param> -> Data sent to dependency
  • DependencyCall.cs: The policy is build and cached at first usage -> is built and cached (1x) and The policy is build at first usage -> is built at first usage (2x)
  • DependencyCall.cs: Default timeout strategy used by Polly.TimeouPolicy -> Polly.TimeoutPolicy
  • ObjectValidator.cs: ensure that object that not supports NRT is still valid -> that does not support NRT
  • ObjectValidator.cs: Validates if instance of object is is not braking NRT rules for objects that not enables it. -> is not breaking NRT rules for objects that do not enable it. (doubled is, braking -> breaking)
  • ErrorHandlingMiddleware.cs: we might not be able o wrote to response, so whe just log this fact -> not be able to write to response, so we just log this fact
  • ErrorHandlingMiddlewareExtensions.cs: validation handling support of requets -> requests
  • ErrorHandlingMiddlewareExtensions.cs: Custom validation confgiruation -> Custom validation configuration
  • ErrorHandlingMiddlewareExtensions.cs: <param name="services">Service collections</param> -> Service collection (2x; the parameter is a single IServiceCollection)
  • EnumHelper.cs: Tires to parse enum value -> Tries to parse enum value

Strings - please review carefully

  • Money.Operators.cs: $"Invalid currency! {c1} is different than {{c2}}" -> {c2}. The doubled braces escape the interpolation, so this exception currently prints the literal text {c2} instead of the second currency. The identical message 30 lines below (in Compare) already uses {c2}.
  • QueryDispatcher.cs: $"Multiple handler for query ..." -> Multiple handlers for query ... (exception message)
  • ExcludeFromSamplingTelemetryInitializer.cs: log template This rule will be not applied -> This rule will not be applied (word order only; the {FilterKey} / {FilterValue} / {FilterType} placeholders are untouched)
  • ErrorHandlingController.cs (Demo): Data = "Custom resposne data" -> "Custom response data"

I grepped the repo for each of these strings - nothing else references them and no test asserts on them.

No versions or CHANGELOGs were bumped, since nothing here changes package behaviour apart from the Money exception text; happy to add those if you would prefer.

Also spotted but not touched, since it was outside the scope I was working from: src/Allegro.Extensions.AspNetCore/README.md line 128 has the same error resposne typo. Say the word and I will include it.

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.

1 participant