NVIDIA / NVIDIA/cudf

[BUG] Series accessors aren't being doctested.

Open
#11,606 1 comment 0 reactions 0 assignees View on GitHub
bug Python
Dominant language
C++
Stars
9.8k
Forks
1.1k
Avg merge
3d 6m
Merged PRs (30d)
278

Description

**Describe the bug**
It appears that the special type accessors for `Series.str` (`StringMethods`) are not being doctested. See https://github.com/rapidsai/cudf/pull/11575#discussion_r953925683. I suspect this is also true for list and struct accessors but have not verified that.

**Expected behavior**
Doctests should run for type-accessors inheriting from `ColumnMethods` like `Series.str.findall`.

This will probably require some updates to [test_doctests.py](https://github.com/rapidsai/cudf/blob/main/python/cudf/cudf/tests/test_doctests.py) to ensure that these accessor methods are found and tested. It may require a special set of tests explicitly designed for finding and testing all `ColumnMethods` objects.

Contributor guide

Open the contributing guide

Research direction

Start by reading python/cudf/cudf/tests/test_doctests.py and checking how Series accessors such as Series.str.findall are discovered. Verify whether list and struct accessors inheriting from ColumnMethods are also omitted. Done means doctests run for these accessor methods, with tests covering the discovery behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.