Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Python] Address docstrings in Data Types Factory Functions #33741

Closed
Tracked by #32356
AlenkaF opened this issue Jan 18, 2023 · 0 comments · Fixed by #33785
Closed
Tracked by #32356

[Python] Address docstrings in Data Types Factory Functions #33741

AlenkaF opened this issue Jan 18, 2023 · 0 comments · Fixed by #33785
Assignees
@AlenkaF
Labels
Component: Python Type: enhancement
Milestone
12.0.0

Comments

@AlenkaF
Copy link
Member

AlenkaF commented Jan 18, 2023

Describe the enhancement requested

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

Component(s)

Python
@AlenkaF AlenkaF mentioned this issue Jan 18, 2023
Closed
3 tasks
@AlenkaF AlenkaF self-assigned this Jan 19, 2023
@github-actions github-actions bot mentioned this issue Jan 19, 2023
Merged
@jorisvandenbossche jorisvandenbossche added this to the 12.0.0 milestone Mar 16, 2023
jorisvandenbossche added a commit that referenced this issue Mar 16, 2023
@AlenkaF @jorisvandenbossche
GH-33741: [Python] Address docstrings in Data Types Factory Functions (…
427f1b6 
…#33785)

### Rationale for this change
Ensure docstrings for [Data Types Factory Functions](https://arrow.apache.org/docs/python/api/datatypes.html#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.
* Closes: #33741

Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
rtpsw pushed a commit to rtpsw/arrow that referenced this issue Mar 27, 2023
@AlenkaF @jorisvandenbossche @rtpsw
apacheGH-33741: [Python] Address docstrings in Data Types Factory Fun…
79305bb 
…ctions (apache#33785)

### Rationale for this change
Ensure docstrings for [Data Types Factory Functions](https://arrow.apache.org/docs/python/api/datatypes.html#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.
* Closes: apache#33741

Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlenkaF AlenkaF

Labels
Component: Python Type: enhancement
Projects
None yet
Milestone
12.0.0
Development

Successfully merging a pull request may close this issue.

GH-33741: [Python] Address docstrings in Data Types Factory Functions AlenkaF/arrow
2 participants
@jorisvandenbossche @AlenkaF