Skip to content

Commit

Permalink
SNOW-1791556: Use docstrings folder for Index methods and properties (#…
Browse files Browse the repository at this point in the history
…2581)

<!---
Please answer these questions before creating your pull request. Thanks!
--->

1. Which Jira issue is this PR addressing? Make sure that there is an
accompanying issue to your PR.

   <!---
   In this section, please add a Snowflake Jira issue number.

Note that if a corresponding GitHub issue exists, you should still
include
   the Snowflake Jira issue number. For example, for GitHub issue
#1400, you should
   add "SNOW-1335071" here.
    --->

   Fixes SNOW-1791556

2. Fill out the following pre-review checklist:

- [ ] I am adding a new automated test(s) to verify correctness of my
new code
- [ ] If this test skips Local Testing mode, I'm requesting review from
@snowflakedb/local-testing
   - [ ] I am adding new logging messages
   - [ ] I am adding a new telemetry message
   - [ ] I am adding new credentials
   - [ ] I am adding a new dependency
- [ ] If this is a new feature/behavior, I'm adding the Local Testing
parity changes.
- [ ] I acknowledge that I have ensured my changes to be thread-safe.
Follow the link for more information: [Thread-safe Developer
Guidelines](https://docs.google.com/document/d/162d_i4zZ2AfcGRXojj0jByt8EUq-DrSHPPnTa4QvwbA/edit#bookmark=id.e82u4nekq80k)

3. Please describe how your code solves the related issue.

Use docstrings folder for Index methods and properties. Docstrings for
DatetimeIndex and TimedeltaIndex will be treated similarly in follow-up
PRs.
  • Loading branch information
sfc-gh-helmeleegy authored Nov 7, 2024
1 parent 9f525c7 commit 32b7f52
Show file tree
Hide file tree
Showing 3 changed files with 2,244 additions and 1,939 deletions.
2 changes: 2 additions & 0 deletions src/snowflake/snowpark/modin/plugin/docstrings/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
DataFrameGroupBy,
SeriesGroupBy,
)
from snowflake.snowpark.modin.plugin.docstrings.index import Index
from snowflake.snowpark.modin.plugin.docstrings.io import * # noqa: F401,F403
from snowflake.snowpark.modin.plugin.docstrings.resample import Resampler
from snowflake.snowpark.modin.plugin.docstrings.series import Series
Expand All @@ -31,4 +32,5 @@
"Series",
"SeriesGroupBy",
"StringMethods",
"Index",
]
Loading

0 comments on commit 32b7f52

Please sign in to comment.