Skip to content

ARROW-16018: [Doc][Python] Run doctests on Python docstring examples (--doctest-cython)#13204

Closed
AlenkaF wants to merge 9 commits intoapache:masterfrom
AlenkaF:ARROW-16018-doctest-cython
Closed

ARROW-16018: [Doc][Python] Run doctests on Python docstring examples (--doctest-cython)#13204
AlenkaF wants to merge 9 commits intoapache:masterfrom
AlenkaF:ARROW-16018-doctest-cython

Conversation

@AlenkaF
Copy link
Member

@AlenkaF AlenkaF commented May 20, 2022

Adding --doctest-cython functionality which will be run on the CI with a follow-up PR.

This PR can be tested with pytest --doctest-cython python/pyarrow.

@github-actions
Copy link

github-actions bot commented May 20, 2022

https://issues.apache.org/jira/browse/ARROW-16018

@github-actions
Copy link

github-actions bot commented May 20, 2022

⚠️ Ticket has not been started in JIRA, please click 'Start Progress'.

@AlenkaF AlenkaF mentioned this pull request May 20, 2022
Closed
3 tasks
jorisvandenbossche
jorisvandenbossche reviewed May 24, 2022
View reviewed changes
jorisvandenbossche pushed a commit that referenced this pull request May 25, 2022
@AlenkaF @jorisvandenbossche
ARROW-16018: [Doc][Python] Run doctests on Python docstring examples …
3b92f02 
…(--doctest-modules)

A series of 3 PRs add `doctest` functionality to ensure that docstring examples are actually correct (and keep being correct).

- [x] Add `--doctest-module`
- [x] Add `--doctest-cython` #13204
- [x] Create a CI job #13216

This PR can be tested with `pytest --doctest-modules python/pyarrow`.

Closes #13199 from AlenkaF/ARROW-16018

Lead-authored-by: Alenka Frim <[email protected]>
Co-authored-by: Alenka Frim <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
@AlenkaF AlenkaF force-pushed the ARROW-16018-doctest-cython branch from dbddde7 to 7c2ef42 Compare May 25, 2022 13:57
@AlenkaF AlenkaF force-pushed the ARROW-16018-doctest-cython branch from 7c2ef42 to 530d827 Compare May 26, 2022 09:38
@amol- amol- closed this in 9a7cc52 May 26, 2022
@AlenkaF AlenkaF deleted the ARROW-16018-doctest-cython branch May 26, 2022 14:09
@ursabot
Copy link

ursabot commented May 26, 2022

Benchmark runs are scheduled for baseline = 5eaae54 and contender = 9a7cc52. 9a7cc52 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️0.35% ⬆️0.0%] test-mac-arm
[Finished ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.04% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 9a7cc522 ec2-t3-xlarge-us-east-2
[Finished] 9a7cc522 test-mac-arm
[Finished] 9a7cc522 ursa-i9-9960x
[Finished] 9a7cc522 ursa-thinkcentre-m75q
[Finished] 5eaae545 ec2-t3-xlarge-us-east-2
[Finished] 5eaae545 test-mac-arm
[Finished] 5eaae545 ursa-i9-9960x
[Finished] 5eaae545 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@AlenkaF AlenkaF mentioned this pull request May 30, 2022
Merged
@asfimport asfimport mentioned this pull request May 26, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche left review comments

Assignees

No one assigned

Labels

Component: Python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AlenkaF @ursabot @jorisvandenbossche