Skip to content

docs: further tweaked docs building and publishing to fix warnings.#5

Merged
JerrettDavis merged 1 commit intomainfrom
4-api-path-is-still-returning-a-404
Sep 15, 2025
Merged

docs: further tweaked docs building and publishing to fix warnings.#5
JerrettDavis merged 1 commit intomainfrom
4-api-path-is-still-returning-a-404

Conversation

@JerrettDavis
Copy link
Copy Markdown
Owner

No description provided.

@JerrettDavis JerrettDavis linked an issue Sep 15, 2025 that may be closed by this pull request
@JerrettDavis JerrettDavis merged commit 6990392 into main Sep 15, 2025
3 checks passed
@JerrettDavis JerrettDavis deleted the 4-api-path-is-still-returning-a-404 branch September 15, 2025 03:57
Copy link
Copy Markdown
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 PR addresses documentation build warnings by making several targeted fixes to improve XML documentation generation and remove problematic references.

  • Updated project configuration to enable documentation file generation
  • Fixed XML documentation reference warnings by updating method references to valid API paths
  • Removed unused code and documentation that was causing build issues

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/PatternKit.Generators.Abstractions/PatternKit.Generators.Abstractions.csproj Added documentation generation properties to fix build warnings
src/PatternKit.Examples/Chain/AuthLoggingDemo.cs Fixed XML documentation references and removed unused HttpResponse struct
test/PatternKit.Tests/Creational/Builder/BranchBuilderTests.cs Improved test assertions using xUnit's Assert.Single method
docs/index.md Removed broken cross-references and updated table formatting

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link
Copy Markdown
Contributor

Code Coverage

Summary
  Generated on: 09/15/2025 - 03:58:07
  Coverage date: 09/15/2025 - 03:57:59 - 09/15/2025 - 03:58:04
  Parser: MultiReport (6x Cobertura)
  Assemblies: 4
  Classes: 64
  Files: 28
  Line coverage: 87.9%
  Covered lines: 1241
  Uncovered lines: 170
  Coverable lines: 1411
  Total lines: 5038
  Branch coverage: 77.6% (337 of 434)
  Covered branches: 337
  Total branches: 434
  Method coverage: 85.9% (330 of 384)
  Full method coverage: 80.4% (309 of 384)
  Covered methods: 330
  Fully covered methods: 309
  Total methods: 384

PatternKit.Core                                                                  92.6%
  PatternKit.Behavioral.Chain.ActionChain<T>                                     84.7%
  PatternKit.Behavioral.Chain.ResultChain<T1, T2>                                 100%
  PatternKit.Behavioral.Strategy.ActionStrategy<T>                                 97%
  PatternKit.Behavioral.Strategy.AsyncStrategy<T1, T2>                           93.5%
  PatternKit.Behavioral.Strategy.Strategy<T1, T2>                                 100%
  PatternKit.Behavioral.Strategy.TryStrategy<T1, T2>                             95.8%
  PatternKit.Common.Option<T>                                                      60%
  PatternKit.Common.Throw                                                         100%
  PatternKit.Common.TryHandlerExtensions                                         33.3%
  PatternKit.Creational.Builder.BranchBuilder<T1, T2>                             100%
  PatternKit.Creational.Builder.BuilderExtensions                                 100%
  PatternKit.Creational.Builder.ChainBuilder<T>                                   100%
  PatternKit.Creational.Builder.Composer<T1, T2>                                  100%
  PatternKit.Creational.Builder.MutableBuilder<T>                                 100%

PatternKit.Examples                                                              86.3%
  PatternKit.Examples.ApiGateway.Demo                                            97.8%
  PatternKit.Examples.ApiGateway.MiniRouter                                      96.6%
  PatternKit.Examples.ApiGateway.Request                                           75%
  PatternKit.Examples.ApiGateway.Response                                         100%
  PatternKit.Examples.ApiGateway.Responses                                        100%
  PatternKit.Examples.Chain.AuthLoggingDemo                                      95.2%
  PatternKit.Examples.Chain.CardProcessors                                        100%
  PatternKit.Examples.Chain.CardTenderStrategy                                      0%
  PatternKit.Examples.Chain.CashTenderStrategy                                      0%
  PatternKit.Examples.Chain.ChainStage                                            100%
  PatternKit.Examples.Chain.CharityRoundUpRule                                     20%
  PatternKit.Examples.Chain.ConfigDriven.Bundle1OffEach                          14.2%
  PatternKit.Examples.Chain.ConfigDriven.CardTender                              72.2%
  PatternKit.Examples.Chain.ConfigDriven.Cash2Pct                                16.6%
  PatternKit.Examples.Chain.ConfigDriven.CashTender                              90.9%
  PatternKit.Examples.Chain.ConfigDriven.CharityRoundUp                           100%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineBuilderExtensions   94.2%
  PatternKit.Examples.Chain.ConfigDriven.ConfigDrivenPipelineDemo                 100%
  PatternKit.Examples.Chain.ConfigDriven.Loyalty5Pct                               20%
  PatternKit.Examples.Chain.ConfigDriven.NickelCashOnly                          77.7%
  PatternKit.Examples.Chain.ConfigDriven.PipelineOptions                          100%
  PatternKit.Examples.Chain.Customer                                              100%
  PatternKit.Examples.Chain.DeviceBus                                             100%
  PatternKit.Examples.Chain.GenericProcessor                                      100%
  PatternKit.Examples.Chain.HttpRequest                                           100%
  PatternKit.Examples.Chain.IRoundingRule                                         100%
  PatternKit.Examples.Chain.LineItem                                              100%
  PatternKit.Examples.Chain.MediatedTransactionPipelineDemo                       100%
  PatternKit.Examples.Chain.NickelCashOnlyRule                                    100%
  PatternKit.Examples.Chain.NoopCharityTracker                                      0%
  PatternKit.Examples.Chain.RoundingPipeline                                      100%
  PatternKit.Examples.Chain.Tender                                                100%
  PatternKit.Examples.Chain.TenderRouterFactory                                  91.3%
  PatternKit.Examples.Chain.TenderStrategyRegistry                                  0%
  PatternKit.Examples.Chain.TransactionContext                                    100%
  PatternKit.Examples.Chain.TransactionPipeline                                   100%
  PatternKit.Examples.Chain.TransactionPipelineBuilder                           92.3%
  PatternKit.Examples.Chain.TxResult                                              100%
  PatternKit.Examples.Coercion.Coercer<T>                                        83.3%
  PatternKit.Examples.Coercion.CoercerExtensions                                  100%
  PatternKit.Examples.Generators.IntParser                                         60%
  PatternKit.Examples.Generators.OrderRouter                                     95.2%
  PatternKit.Examples.Generators.ScoreLabeler                                     100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicy                           100%
  PatternKit.Examples.Strategies.Composed.ChannelPolicyFactory                    100%
  PatternKit.Examples.Strategies.Composed.ComposedStrategies                     94.2%
  PatternKit.Examples.Strategies.Composed.SendContext                             100%
  PatternKit.Examples.Strategies.Composed.SendResult                              100%

PatternKit.Generators                                                            93.9%
  PatternKit.Generators.StrategyGenerator                                        93.9%

PatternKit.Generators.Abstractions                                                  0%
  PatternKit.Generators.GenerateStrategyAttribute                                   0%

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.85%. Comparing base (e1857b0) to head (9b3e6af).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #5      +/-   ##
==========================================
+ Coverage   85.17%   89.85%   +4.67%     
==========================================
  Files          22       22              
  Lines        1302     1301       -1     
  Branches      153      153              
==========================================
+ Hits         1109     1169      +60     
+ Misses        152      132      -20     
+ Partials       41        0      -41     
Flag Coverage Δ
unittests 89.85% <100.00%> (+4.67%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@JerrettDavis JerrettDavis added bug Something isn't working documentation Improvements or additions to documentation labels Sep 16, 2025
@JerrettDavis JerrettDavis self-assigned this Sep 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Api Path is still returning a 404.

3 participants