Skip to content

GH-33741: [Python] Address docstrings in Data Types Factory Functions#33785

Merged
jorisvandenbossche merged 11 commits into
apache:mainfrom
AlenkaF:gh-33741-docstrings-data-types-functions
Mar 16, 2023
Merged

GH-33741: [Python] Address docstrings in Data Types Factory Functions#33785
jorisvandenbossche merged 11 commits into
apache:mainfrom
AlenkaF:gh-33741-docstrings-data-types-functions

Conversation

@AlenkaF

@AlenkaF AlenkaF commented Jan 19, 2023 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Rationale for this change

Ensure docstrings for Data Types Factory Functions have an Examples section.

What changes are included in this PR?

Docstrings are added to listed Data Types Factory Functions.

Are these changes tested?

Yes, locally with pytest --doctest-cython --disable-warnings pyarrow and on the CI with Python / AMD64 Conda Python 3.9 Sphinx & Numpydoc build.

Are there any user-facing changes?

No.

@github-actions

github-actions Bot commented Jan 19, 2023

Copy link
Copy Markdown

danepitkin
danepitkin reviewed Feb 15, 2023
View reviewed changes
Comment thread python/pyarrow/types.pxi Outdated
danepitkin
danepitkin reviewed Feb 15, 2023
View reviewed changes

@danepitkin danepitkin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few small suggestions, but overall LGTM!

Comment thread python/pyarrow/types.pxi Outdated
@AlenkaF AlenkaF requested a review from danepitkin February 20, 2023 09:11
jorisvandenbossche
jorisvandenbossche reviewed Feb 21, 2023
View reviewed changes

@jorisvandenbossche jorisvandenbossche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some tiny comments, but generally looks good!

Comment thread python/pyarrow/types.pxi Outdated
Comment thread python/pyarrow/types.pxi Outdated
Comment thread python/pyarrow/types.pxi Outdated
Comment thread python/pyarrow/types.pxi Outdated
Comment thread python/pyarrow/types.pxi Outdated
AlenkaF and others added 11 commits February 28, 2023 09:46
@AlenkaF
Add docstring examples for null, boolean, signed and unsigned int types
f4b4e63
@AlenkaF
Add docstring examples for float types
5f12979
@AlenkaF
Add docstring examples to time, date, timestamp, duration and month_d…
d5729f6 
…ay_nano_interval types
@AlenkaF
Add docstring examples for binary and string types
58b4e47
@AlenkaF
Add the rest of docstring examples for data types factory functions
f4d612e
@AlenkaF
Rename field in bool_() and add creating and array example in float16()
340bec5
@AlenkaF @jorisvandenbossche
Apply suggestions from code review - Joris
ddc8ef6 
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@AlenkaF
Change UTC timezone example instead of fixed offset in timestamp()
4a9c784
@AlenkaF
Correct doctest example result for map_()
3f28e5f
@AlenkaF
Use datetime.date insted datetime.datetime for date32()
c8643c5
@AlenkaF
Remove * 50 from large_binary docstring example
61fd32b
@AlenkaF AlenkaF force-pushed the gh-33741-docstrings-data-types-functions branch from a9e50c3 to 61fd32b Compare February 28, 2023 08:46
@AlenkaF AlenkaF requested review from jorisvandenbossche and removed request for danepitkin February 28, 2023 13:32
@AlenkaF AlenkaF added this to the 12.0.0 milestone Mar 16, 2023
@jorisvandenbossche jorisvandenbossche merged commit 427f1b6 into apache:main Mar 16, 2023
@jorisvandenbossche

jorisvandenbossche commented Mar 16, 2023

Copy link
Copy Markdown
Member

Thanks!

@AlenkaF AlenkaF deleted the gh-33741-docstrings-data-types-functions branch March 16, 2023 14:43
@ursabot

ursabot commented Mar 16, 2023

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = fe88d9a and contender = 427f1b6. 427f1b6 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.12% ⬆️0.03%] test-mac-arm
[Finished ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.09% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 427f1b64 ec2-t3-xlarge-us-east-2
[Finished] 427f1b64 test-mac-arm
[Finished] 427f1b64 ursa-i9-9960x
[Finished] 427f1b64 ursa-thinkcentre-m75q
[Finished] fe88d9ad ec2-t3-xlarge-us-east-2
[Finished] fe88d9ad test-mac-arm
[Finished] fe88d9ad ursa-i9-9960x
[Finished] fe88d9ad 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danepitkin danepitkin danepitkin left review comments
@jorisvandenbossche jorisvandenbossche Awaiting requested review from jorisvandenbossche

Assignees

No one assigned

Labels

Component: Python

Projects

None yet

Milestone

12.0.0

Development

Successfully merging this pull request may close these issues.

[Python] Address docstrings in Data Types Factory Functions

4 participants

@AlenkaF @jorisvandenbossche @ursabot @danepitkin