docs: fix and improve docstrings in three operators [Repo Assist]#789
Open
github-actions[bot] wants to merge 1 commit into
Open
docs: fix and improve docstrings in three operators [Repo Assist]#789github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…omarbles operators - _groupbyuntil.py: add missing 'element_mapper' to docstring Args section - _publishvalue.py: add missing docstring for publish_value_() implementation - _tomarbles.py: move docstring to outer to_marbles() function (the public interface), remove inner-closure docstring, add to_marbles to __all__ Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dbrattli
approved these changes
May 9, 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.
🤖 This PR was created by Repo Assist, an automated AI assistant.
Summary
Three small but clear docstring issues identified in the operator implementation files:
1.
_groupbyuntil.py— missingelement_mapperin ArgsThe
group_by_until_()function signature has four parameters, but the docstringArgssection only documented three of them —element_mapperwas silently omitted. Added the missing entry with a brief description.2.
_publishvalue.py— no docstring at allpublish_value_()was the only operator implementation function in the codebase without any docstring (102 others have one). Added a full docstring matching the project's style, describing the BehaviorSubject specialisation.3.
_tomarbles.py— docstring in wrong place +__all__incompletedef to_marbles(source)) rather than on the outer factory function (def to_marbles(timespan, scheduler)). IDEs and tools such ashelp()read the outer function's docstring — moved it there and removed the now-redundant inner docstring.__all__listed only["stringify"], omittingto_marbles. Fixed to["to_marbles", "stringify"]sofrom reactivex.operators._tomarbles import *exports the main function.Changes
reactivex/operators/_groupbyuntil.pyelement_mappertoArgsdocstringreactivex/operators/_publishvalue.pypublish_value_()reactivex/operators/_tomarbles.pyto_marblesto__all__No logic changes. CI will validate via
uv run ruff check,uv run pyright, anduv run pytest.Note
🔒 Integrity filter blocked 50 items
The following items were blocked because they don't meet the GitHub integrity level.
list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".from_iterablewith a generator the generator might not be closed #546list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".list_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".To allow these resources, lower
min-integrityin your GitHub frontmatter: