Skip to content
This repository was archived by the owner on Apr 1, 2026. It is now read-only.

Commit ee3a9c3

Browse files
committed
add note about doctest
1 parent cd2573e commit ee3a9c3

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

GEMINI.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,17 @@ corresponding `third_party/bigframes_vendored/package_name` directory, not in
5353
the `bigframes` directory. Implementations may be placed in the `bigframes`
5454
directory, though.
5555

56+
### Testing code samples
57+
58+
Code samples are very important for accurate documentation. We use the "doctest"
59+
framework to ensure the samples are functioning as expected. After adding a code
60+
sample, please ensure it is correct by running doctest. To run the samples
61+
doctests for just a single method, refer to the following example:
62+
63+
```bash
64+
pytest --doctest-modules bigframes/pandas/__init__.py::bigframes.pandas.cut
65+
```
66+
5667
## Tips for implementing common BigFrames features
5768

5869
### Adding a scalar operator

0 commit comments

Comments
 (0)