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

BUG: BasePandasDataset tries to inherit custom docstrings from DataFrame instead of from a separate base class #7134

Open
mvashishtha opened this issue Mar 27, 2024 · 0 comments
Open

BUG: BasePandasDataset tries to inherit custom docstrings from DataFrame instead of from a separate base class #7134

mvashishtha opened this issue Mar 27, 2024 · 0 comments
Labels
Enable plugin Fixes needed to enable external plugins P3 Very minor bugs, or features we can hopefully add some day.

Comments

@mvashishtha
Copy link
Collaborator

Modin's BasePandasDataset inherits docstrings from pandas.DataFrame, so any docstring overrides for dataframe affect BasePandasDataset. Some options:

  1. we could have the base dataset inherit from the pandas base class instead, but that might change some existing docstrings
  2. we could explicitly choose a parent docstring class for BasePandasDataset in _inherit_docstrings
  3. we could accept some incorrect docstrings in BasePandasDataset

@devin-petersohn and I prefer option 2)
@mvashishtha mvashishtha added P3 Very minor bugs, or features we can hopefully add some day. Enable plugin Fixes needed to enable external plugins labels Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Enable plugin Fixes needed to enable external plugins P3 Very minor bugs, or features we can hopefully add some day.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mvashishtha @sfc-gh-mvashishtha