Document NBP publication schedules in client XML docs - #23
Merged
Merged
Conversation
Each interface and method states when its table is published (Europe/ Warsaw): A on business days 11:45-12:15, B on Wednesdays 11:45-12:15 (previous business day if Wednesday is a holiday), C on business days 7:45-8:15, gold on business days. Today methods explain the NotFoundError before publication and point to the Latest method. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The client classes had no XML docs, so callers using them directly (new NbpGoldPriceClient(httpClient)) saw none of the limits or publication schedules. Methods now use <inheritdoc/>, classes inherit the interface summary, and constructors are documented. Also: say NotFoundError instead of 'can return no data', clearer Latest remarks, and grammar fixes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
milten89
added a commit
that referenced
this pull request
Oct 1, 2026
- P1: drop item 11, which #22 fixed (the #23 merge put it back); add item 27, the unconfirmed gold publication hour. - P2: items 12 and 13 describe what is left after #16-#18; item 26 (WireMock error paths per client) goes with item 12. - P3: item 20 is no longer a vulnerability after #12; item 21 notes what is documented; new items 24 (Microsoft.Testing.Platform, blocks Dependabot #11) and 25 (outdated GITHUB-SETUP.md). Item 22 points to the new prose skills. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
milten89
added a commit
that referenced
this pull request
Oct 1, 2026
- P1: drop item 11, which #22 fixed (the #23 merge put it back); add item 27, the unconfirmed gold publication hour. - P2: items 12 and 13 describe what is left after #16-#18; item 26 (WireMock error paths per client) goes with item 12. - P3: item 20 is no longer a vulnerability after #12; item 21 notes what is documented; new items 24 (Microsoft.Testing.Platform, blocks Dependabot #11) and 25 (outdated GITHUB-SETUP.md). Item 22 points to the new prose skills. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
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
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.
Fixes BACKLOG P1 item 10.
Publication schedule (Europe/Warsaw time)
Source: NBP's "Informacja o terminach publikacji kursów walut". The site blocks automated browsers, so I read it through the search engine's copy.
Changes
<remarks>with the schedule of the table it reads (mid methods: A/B, buy-sell methods: C, gold), and each interface summarises it.NotFoundError. They point to the matching Latest method with<see cref>. Latest methods explain that they return the previous value until the next publication.NotFoundError.NbpCurrencyExchangeRateClient,NbpExchangeRateTableClient,NbpGoldPriceClient): all 25 public methods use<inheritdoc/>, the classes inherit the interface summary, and the constructors are documented. Without this, callers using the classes directly (the ADR-0007 default) saw none of the docs;CS1591is suppressed, which hid the gap.Merge note: this PR and #22 remove adjacent lines in
docs/BACKLOG.md(items 10 and 11), so whichever merges second will show a one-line conflict. Ask me to update that PR and I'll resolve it.Verification
dotnet build OpenUrzednik.slnx: 0 errors, nocrefwarnings.dotnet test -f net10.0: Core 90/90, Nbp 556/556, IntegrationTests 47 passed / 9 skipped (manual tests).dotnet format --verify-no-changes: clean.revieweragent: no blocking findings. I fixed its should-fix point (<inheritdoc/>on the concrete clients) and nits (Latest wording, gold wording,NotFoundErrorin summaries, grammar).🤖 Generated with Claude Code