docs: fix incorrect and non-existent API references in markdown files#37
Merged
Conversation
Corrected ~50 broken code examples across 12 documentation files. Examples referenced methods and types that do not exist in source, which would cause compilation errors for users copying the snippets. Key fixes: - README.MD: Maybe.From (not Return), RuleEngine.And/Or (not Create), AnyActionResult<T> return type, Error two-param signatures, onError param - Examples.RequestResponseLogging: IApplicationBuilder extension (not IServiceCollection), real opt.IgnorePaths+UseLogger API (removed 6 non-existent properties) - Examples.EntityFrameworkCore: BaseDbContext<T> generic + IServiceScopeFactory, ConfigureEnumConventions (not UseSnakeCaseNamingConvention), PaginateAsync (not ToPaginatedList), response.Next (not NextCursor) - Examples.Enums: real source-generated methods (not GetStringValue/GetCount/ParseEnum) - Examples.Json: ConvertToJson/FromJson (not IsValidJson/ToPrettyJson/MinifyJson) - Examples.Time: ToDateOnly/ToTimeOnly only (not StartOfDay..ToUnixTimestamp) - Examples.Any: Any.Create<T0,T1> (not Any.From), full type params on Is<>/As<> - Examples.Rules: Func<T,Result>.ToRule() (not Rule.Create<T>) - Examples.Core: correct Guider, Collection, RandomItems method names - API_REFERENCE.md: CSharpEssentials.Validation (not FluentValidation), ResultPattern namespace note, missing SuccessIf/FailureIf overloads - CONTRIBUTING.md: added setup commands, .NET SDK requirement, updated GitHub Flow URL - BENCHMARKS.md: .NET 11 marked as preview Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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
dotnet buildpasses — no source code changes, docs onlyChanges
README.MDMaybe.Return→From,Fallback→GetValueOrDefault,Rule.Create→Func+ToRule,RuleEngine.Create→And/Or,AddCSharpEssentials→AddEnhancedProblemDetails,onFailure→onError,AnyActionResult<T>return type,Errortwo-param signaturesExamples.RequestResponseLogging/README.mdIServiceCollection→IApplicationBuilder, removed 6 non-existent options (LogRequestBody,PathFilter, etc.),ILogWriterinternal note, realIgnorePaths+UseLoggerAPIExamples.EntityFrameworkCore/README.mdBaseDbContext<T>generic +IServiceScopeFactory,ConfigureEnumConventions(notUseSnakeCaseNamingConvention),PaginateAsync(notToPaginatedList),response.Next(notNextCursor)Examples.Enums/README.mdGetStringValue/GetCount/ParseEnum)Examples.Json/README.mdConvertToJson/FromJson(notIsValidJson/ToPrettyJson/MinifyJson)Examples.Time/README.mdToDateOnly/ToTimeOnlyonly (notStartOfDay..ToUnixTimestamp)Examples.Any/README.mdAny.Create<T0,T1>(notAny.From), full type params onIs<>/As<>,Any<T0,T1>namingExamples.Rules/README.mdFunc<T,Result>.ToRule()(notRule.Create<T>)Examples.Core/README.mdToStringFromGuid,IfAdd/IfAddRange,GetRandomItem/GetRandomItemsdocs/API_REFERENCE.mdCSharpEssentials.Validation(not FluentValidation),ResultPatternnamespace note, missingSuccessIf/FailureIf<TValue>overloads,Result.Tryall 4 overloads,Matchpartial (not exhaustive)CONTRIBUTING.mdBENCHMARKS.mdTest plan
dotnet buildpasses (exit code 0)🤖 Generated with Claude Code