Add docstrings to all type stubs in python/natsrpy#27
Merged
Conversation
Co-authored-by: s3rius <18153319+s3rius@users.noreply.github.com> Agent-Logs-Url: https://github.com/taskiq-python/natsrpy/sessions/ea16012c-d53a-4a4b-b494-c9dec5f0ab4b
Copilot created this pull request from a session on behalf of
s3rius
March 25, 2026 23:42
View session
s3rius
approved these changes
Mar 25, 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.
Adds comprehensive docstrings to all
.pyitype stubs across thepython/natsrpy/_natsrpy_rs/package.Changes
__init__.pyi— Docstrings forNats,IteratorSubscription,CallbackSubscriptionand all public methodsexceptions.pyi— Docstrings forNatsrpyBaseError,NatsrpySessionError,NatsrpyPublishErrorjs/__init__.pyi— Docstrings forPublication,JetStream,JetStreamMessage(class, all properties, all ack methods)js/stream.pyi— Docstrings for all enums (StorageType,DiscardPolicy, etc.), config/data classes (StreamConfig,StreamInfo, etc.), andStreamjs/kv.pyi— Docstrings forKVStatus,KVOperation,KVEntry, iterators,KVConfig, and allKeyValuemethodsjs/object_store.pyi— Docstrings forObjectStoreConfig,ObjectInfo,ObjectLink,ObjectStoreand all methodsjs/managers.pyi— Docstrings forStreamsManager,KVManager,ConsumersManager,ObjectStoreManagerjs/consumers.pyi— Docstrings forDeliverPolicy,AckPolicy,ReplayPolicy,PriorityPolicy, both consumer configs,MessagesIterator,PushConsumer,PullConsumerFixes to existing docstrings
JetStreamMessage.progress(): "Singnals" → "Signals", "mesasge" → "message"JetStreamMessage.nack()::param duration:→:param delay:Convention
Class docstrings use
Attributes:sections for data/config classes. Method docstrings use Sphinx-style:param:/:return:notation, matching the pre-existing style inStream.direct_getandJetStreamMessage.ack.