Skip to content

[Data] [Docs] Add missing MOD operation documentation in Operation enum#60803

Merged
richardliaw merged 2 commits into
ray-project:masterfrom
slfan1989:docs/add-mod-operation-docs
Feb 6, 2026
Merged

[Data] [Docs] Add missing MOD operation documentation in Operation enum#60803
richardliaw merged 2 commits into
ray-project:masterfrom
slfan1989:docs/add-mod-operation-docs

Conversation

@slfan1989

Copy link
Copy Markdown
Contributor

Description

Add missing documentation for the MOD (modulo) operation in the Operation enum's docstring. The MOD operation was already implemented in the enum (line 74) and fully functional, but was accidentally omitted from the class-level docstring that lists all available operations.

This PR improves API documentation completeness by documenting the modulo operation alongside other arithmetic operations like ADD, SUB, MUL, DIV, and FLOORDIV.

Related issues

N/A - Documentation improvement only

Additional information

  • Change: Added MOD: Modulo operation (%) to the Attributes section of the Operation enum docstring
The MOD (modulo) operation was already defined in the Operation enum
but was missing from the class-level docstring. This commit adds the
documentation for the MOD operation to improve API documentation completeness.

Signed-off-by: slfan1989 <slfan1989@apache.org>
@slfan1989 slfan1989 requested a review from a team as a code owner February 6, 2026 08:05

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly adds the missing documentation for the MOD (modulo) operation to the Operation enum's docstring. The change is straightforward and improves the completeness of the API documentation. While this PR focuses on the enum docstring, a related improvement would be to fix a small typo in the docstrings for the __mod__ and __rmod__ methods in the Expr class, changing 'Modulation operator' to 'Modulo operator' for consistency.

@slfan1989

Copy link
Copy Markdown
Contributor Author

@alexeykudinkin Could you please review this documentation fix? Thanks! This minor issue was introduced in #55920.

@ray-gardener ray-gardener Bot added the community-contribution Contributed by the community label Feb 6, 2026
@goutamvenkat-anyscale goutamvenkat-anyscale added data Ray Data-related issues go add ONLY when ready to merge, run all tests labels Feb 6, 2026
@richardliaw richardliaw merged commit b93fc26 into ray-project:master Feb 6, 2026
7 checks passed
@slfan1989

Copy link
Copy Markdown
Contributor Author

@goutamvenkat-anyscale @richardliaw Thanks a lot for reviewing the code!

tiennguyentony pushed a commit to tiennguyentony/ray that referenced this pull request Feb 7, 2026
…um (ray-project#60803)


Signed-off-by: tiennguyentony <46289799+tiennguyentony@users.noreply.github.com>
tiennguyentony pushed a commit to tiennguyentony/ray that referenced this pull request Feb 7, 2026
…um (ray-project#60803)


Signed-off-by: tiennguyentony <46289799+tiennguyentony@users.noreply.github.com>
elliot-barn pushed a commit that referenced this pull request Feb 9, 2026
…um (#60803)

Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
ans9868 pushed a commit to ans9868/ray that referenced this pull request Feb 18, 2026
Aydin-ab pushed a commit to kunling-anyscale/ray that referenced this pull request Feb 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community data Ray Data-related issues go add ONLY when ready to merge, run all tests

3 participants