Skip to content

docs: fix and improve docstrings in three operators [Repo Assist]#789

Open
github-actions[bot] wants to merge 1 commit into
masterfrom
repo-assist/improve-docstrings-2026-05-03-539ff42d5c2c9cb9
Open

docs: fix and improve docstrings in three operators [Repo Assist]#789
github-actions[bot] wants to merge 1 commit into
masterfrom
repo-assist/improve-docstrings-2026-05-03-539ff42d5c2c9cb9

Conversation

@github-actions

@github-actions github-actions Bot commented May 3, 2026

Copy link
Copy Markdown
Contributor

🤖 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 — missing element_mapper in Args

The group_by_until_() function signature has four parameters, but the docstring Args section only documented three of them — element_mapper was silently omitted. Added the missing entry with a brief description.

2. _publishvalue.py — no docstring at all

publish_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__ incomplete

  • The docstring was on the inner closure (def to_marbles(source)) rather than on the outer factory function (def to_marbles(timespan, scheduler)). IDEs and tools such as help() read the outer function's docstring — moved it there and removed the now-redundant inner docstring.
  • __all__ listed only ["stringify"], omitting to_marbles. Fixed to ["to_marbles", "stringify"] so from reactivex.operators._tomarbles import * exports the main function.

Changes

File Change
reactivex/operators/_groupbyuntil.py Added element_mapper to Args docstring
reactivex/operators/_publishvalue.py Added full docstring to publish_value_()
reactivex/operators/_tomarbles.py Moved docstring to outer function; added to_marbles to __all__

No logic changes. CI will validate via uv run ruff check, uv run pyright, and uv run pytest.

Note

🔒 Integrity filter blocked 50 items

The following items were blocked because they don't meet the GitHub integrity level.

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

Generated by Repo Assist · ● 4.5M ·

…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 dbrattli changed the title [Repo Assist] docs: fix and improve docstrings in three operators docs: fix and improve docstrings in three operators [Repo Assist] May 9, 2026
@dbrattli dbrattli marked this pull request as ready for review May 9, 2026 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant