Add see-also references to Orbit packages#1077
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds XML documentation “see also” links to relevant Synadia Orbit NuGet packages, making it easier for consumers of the NATS .NET client APIs to discover complementary extensions and features.
Changes:
- Added
<seealso href="...">...</seealso>references across Core, JetStream, and KeyValueStore public APIs. - Linked specific configuration toggles (e.g., direct access, message TTL, schedules, counters) to Orbit packages that build on those capabilities.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/NATS.Client.KeyValueStore/INatsKVStore.cs | Adds interface-level XML doc summary and a see-also link to KV typed serialization extensions. |
| src/NATS.Client.JetStream/Models/StreamConfig.cs | Adds see-also links for several stream config capabilities (direct access, TTL, counters, schedules, atomic publish). |
| src/NATS.Client.JetStream/Models/ConsumerConfig.cs | Adds see-also links related to partitioned consumer groups for filter-subject configuration. |
| src/NATS.Client.Core/NatsOpts.cs | Adds a see-also link to Orbit NATS context support for loading options from CLI contexts. |
| src/NATS.Client.Core/INatsConnection.cs | Adds a see-also link to Orbit core extensions for advanced request-many stop conditions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -111,13 +111,15 @@ public ConsumerConfig(string name) | |||
| /// <summary> | |||
| /// Filter the stream by a single subjects | |||
There was a problem hiding this comment.
In the XML doc summary, "a single subjects" is grammatically incorrect; it should be singular ("a single subject").
Suggested change
| /// Filter the stream by a single subjects | |
| /// Filter the stream by a single subject |
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
Merged
mtmk
added a commit
that referenced
this pull request
Mar 13, 2026
* Add optional window_size parameter to StreamSnapshotRequest (#1088) * Bump Microsoft.Bcl.Memory from 9.0.0 to 9.0.14 (#1089) * Fix `PingCommand` cancellation (#1086) * rework terminate reason (#1081) * Fix OTel network telemetry tags (#1078) * Add consumer info usage warnings (#1079) * Add TermWithReason support to AckTerminateAsync (#1048) * Fix code analyser warning (#1076) * Add cancelled token handling for consumers (#1068) * Add validation for unsupported PinnedClient calls (#1063) * Add see-also references to Orbit packages (#1077) * Add Synadia.Orbit.Testing.NatsServerProcessManager (#1065) * Add slow consumer docs (#1073) * Fix error logs URI rewritten by OnConnectingAsync (#1067) * Add more tests for JetStream consumer behavior (#1055)
This was referenced Jul 12, 2026
This was referenced Jul 20, 2026
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.
No description provided.