Skip to content

Commit

Permalink
GH-38683: [Python][Docs] Update docstrings for Time32Type and Time64T…
Browse files Browse the repository at this point in the history
…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 <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
  • Loading branch information
AlenkaF authored Dec 19, 2023
1 parent f5dd3d4 commit 9cb78ad
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions python/pyarrow/types.pxi
Original file line number Diff line number Diff line change
Expand Up @@ -1108,6 +1108,9 @@ cdef class Time32Type(DataType):
"""
Concrete class for time32 data types.
Supported time unit resolutions are 's' [second]
and 'ms' [millisecond].
Examples
--------
Create an instance of time32 type:
Expand All @@ -1124,7 +1127,7 @@ cdef class Time32Type(DataType):
@property
def unit(self):
"""
The time unit ('s', 'ms', 'us' or 'ns').
The time unit ('s' or 'ms').
Examples
--------
Expand All @@ -1140,6 +1143,9 @@ cdef class Time64Type(DataType):
"""
Concrete class for time64 data types.
Supported time unit resolutions are 'us' [microsecond]
and 'ns' [nanosecond].
Examples
--------
Create an instance of time64 type:
Expand All @@ -1156,7 +1162,7 @@ cdef class Time64Type(DataType):
@property
def unit(self):
"""
The time unit ('s', 'ms', 'us' or 'ns').
The time unit ('us' or 'ns').
Examples
--------
Expand Down

0 comments on commit 9cb78ad

Please sign in to comment.