Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

FIX-#7113: Fix docstring overrides for subclasses. #7354

Merged
merged 2 commits into from
Aug 1, 2024
Merged

FIX-#7113: Fix docstring overrides for subclasses. #7354

merged 2 commits into from
Aug 1, 2024

Conversation

sfc-gh-mvashishtha
Copy link
Contributor

What do these changes do?

  • first commit message and PR title follow format outlined here

    NOTE: If you edit the PR title to match this format, you need to add another commit (even if it's empty) or amend your last commit for the CI job that checks the PR title to pick up the new PR title.

  • passes flake8 modin/ asv_bench/benchmarks scripts/doc_checker.py
  • passes black --check modin/ asv_bench/benchmarks scripts/doc_checker.py
  • signed commit with git commit -s
  • Resolves BUG: docs extension: unspecified subclass documentation causes superclass documentation to be overridden #7113
  • tests added and passing
  • module layout described at docs/development/architecture.rst is up-to-date

@sfc-gh-mvashishtha
FIX-modin-project#7113: Fix docstring overrides for subclasses.
9890eae 
Signed-off-by: sfc-gh-mvashishtha <mahesh.vashishtha@snowflake.com>
github-advanced-security[bot]
github-advanced-security bot found potential problems Jul 31, 2024
View reviewed changes
modin/tests/config/docs_module/classes.py Dismissed Show dismissed Hide dismissed
@sfc-gh-mvashishtha
Try fixing tests
45e7669 
Signed-off-by: sfc-gh-mvashishtha <mahesh.vashishtha@snowflake.com>
@sfc-gh-mvashishtha sfc-gh-mvashishtha marked this pull request as ready for review July 31, 2024 23:38
devin-petersohn
devin-petersohn approved these changes Aug 1, 2024
View reviewed changes
Copy link
Collaborator

@devin-petersohn devin-petersohn left a comment

Choose a reason for hiding this comment

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

LGTM

@sfc-gh-mvashishtha sfc-gh-mvashishtha merged commit 22ed4d8 into modin-project:main Aug 1, 2024
38 checks passed
@sfc-gh-mvashishtha sfc-gh-mvashishtha deleted the 7113/fix-docstring-overrides-for-subclasses branch August 1, 2024 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@devin-petersohn devin-petersohn devin-petersohn approved these changes

@mvashishtha mvashishtha Awaiting requested review from mvashishtha mvashishtha is a code owner

@RehanSD RehanSD Awaiting requested review from RehanSD RehanSD is a code owner

@YarShev YarShev Awaiting requested review from YarShev YarShev is a code owner

@vnlitvinov vnlitvinov Awaiting requested review from vnlitvinov vnlitvinov is a code owner

@anmyachev anmyachev Awaiting requested review from anmyachev anmyachev is a code owner

@dchigarev dchigarev Awaiting requested review from dchigarev dchigarev is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

BUG: docs extension: unspecified subclass documentation causes superclass documentation to be overridden
2 participants
@sfc-gh-mvashishtha @devin-petersohn