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][Docs] Time32Type "unit" docs are outdated #38683

Closed
Tishj opened this issue Nov 13, 2023 · 2 comments · Fixed by #39059
Closed

[Python][Docs] Time32Type "unit" docs are outdated #38683

Tishj opened this issue Nov 13, 2023 · 2 comments · Fixed by #39059
Assignees
@AlenkaF
Labels
Component: Documentation Component: Python good-first-issue Type: bug
Milestone
15.0.0

Comments

@Tishj
Copy link

Tishj commented Nov 13, 2023

Describe the bug, including details regarding any error messages, version, and platform.

https://arrow.apache.org/docs/python/generated/pyarrow.Time32Type.html

This claims that these are valid options for unit:

The time unit (‘s’, ‘ms’, ‘us’ or ‘ns’).

Using help on the pyarrow.time32 method shows that only s and ms are valid options.

Component(s)

Documentation, Python
@rok
Copy link
Member

rok commented Nov 13, 2023

Agreed. That is not documented correctly.

@jorisvandenbossche jorisvandenbossche changed the title Time32Type "unit" docs are outdated [Python][Docs] Time32Type "unit" docs are outdated Nov 14, 2023
@ShaiviAgarwal2
Copy link

ShaiviAgarwal2 commented Nov 14, 2023 •
edited
Loading

Describe the bug, including details regarding any error messages, version, and platform.

https://arrow.apache.org/docs/python/generated/pyarrow.Time32Type.html

This claims that these are valid options for unit:

The time unit (‘s’, ‘ms’, ‘us’ or ‘ns’).

Using help on the pyarrow.time32 method shows that only s and ms are valid options.

Component(s)

Documentation, Python

Based on the information you provided, it seems that there is a discrepancy between the documentation and the actual implementation of the pyarrow.time32 method. The documentation claims that the valid options for the time unit are 's', 'ms', 'us', or 'ns', while the help command shows that only 's' and 'ms' are valid options. This could potentially cause confusion for developers trying to use this library.

Can you please provide more information about the error messages and version you are using?

@AlenkaF AlenkaF self-assigned this Nov 29, 2023
@AlenkaF AlenkaF added this to the 15.0.0 milestone Dec 1, 2023
@github-actions github-actions bot mentioned this issue Dec 4, 2023
Merged
jorisvandenbossche pushed a commit that referenced this issue Dec 19, 2023
@AlenkaF
GH-38683: [Python][Docs] Update docstrings for Time32Type and Time64T…
9cb78ad 
…ype (#39059)

### Rationale for this change

`Time32Type` and `Time64Type` unit docs are not correctly documented.

### What changes are included in this PR?

Update the docstrings for `Time32Type` and `Time64Type` `unit`.
* Closes: #38683

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
clayburn pushed a commit to clayburn/arrow that referenced this issue Jan 23, 2024
@AlenkaF @clayburn
apacheGH-38683: [Python][Docs] Update docstrings for Time32Type and T…
a50e4a7 
…ime64Type (apache#39059)

### Rationale for this change

`Time32Type` and `Time64Type` unit docs are not correctly documented.

### What changes are included in this PR?

Update the docstrings for `Time32Type` and `Time64Type` `unit`.
* Closes: apache#38683

Authored-by: AlenkaF <frim.alenka@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
dgreiss pushed a commit to dgreiss/arrow that referenced this issue Feb 19, 2024
@AlenkaF @dgreiss
apacheGH-38683: [Python][Docs] Update docstrings for Time32Type and T…
8163113 
…ime64Type (apache#39059)

### Rationale for this change

`Time32Type` and `Time64Type` unit docs are not correctly documented.

### What changes are included in this PR?

Update the docstrings for `Time32Type` and `Time64Type` `unit`.
* Closes: apache#38683

Authored-by: AlenkaF <frim.alenka@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: Documentation Component: Python good-first-issue Type: bug
Projects
None yet
Milestone
15.0.0
Development

Successfully merging a pull request may close this issue.

GH-38683: [Python][Docs] Update docstrings for Time32Type and Time64Type AlenkaF/arrow
4 participants
@rok @AlenkaF @Tishj @ShaiviAgarwal2