Skip to content

Commit e4b5b11

Browse files
tadejaAlenkaF
andauthored
GH-48095: [Python][Docs] Add missing {pyarrow,compute} functions to API docs (#48117)
Issue #48095 and #45322 ### Rationale for this change Missing API doc entries. ### What changes are included in this PR? I've added strings for functions and options to the API doc page. ### Are these changes tested? I've built docs locally. ### Are there any user-facing changes? Docs only. * GitHub Issue: #48095 * Also covers: #45322 Lead-authored-by: Tadeja Kadunc <[email protected]> Co-authored-by: tadeja <[email protected]> Co-authored-by: Alenka Frim <[email protected]> Signed-off-by: AlenkaF <[email protected]>
1 parent 9dfc3af commit e4b5b11

File tree

2 files changed

+92
-2
lines changed

2 files changed

+92
-2
lines changed

docs/source/python/api/arrays.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,21 @@ These functions create new Arrow arrays:
2929
.. autosummary::
3030
:toctree: ../generated/
3131

32+
arange
3233
array
3334
nulls
35+
repeat
3436

3537
Array Types
3638
-----------
3739

40+
This function infers Arrow data type:
41+
42+
.. autosummary::
43+
:toctree: ../generated/
44+
45+
infer_type
46+
3847
An array's Python class depends on its data type. Concrete array classes
3948
may expose data type-specific methods or properties.
4049

@@ -140,6 +149,8 @@ classes may expose data type-specific methods or properties.
140149
TimestampScalar
141150
DurationScalar
142151
MonthDayNanoIntervalScalar
152+
Decimal32Scalar
153+
Decimal64Scalar
143154
Decimal128Scalar
144155
Decimal256Scalar
145156
DictionaryScalar

docs/source/python/api/compute.rst

Lines changed: 81 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ Aggregations
3232
approximate_median
3333
count
3434
count_distinct
35+
first
36+
first_last
3537
index
38+
kurtosis
39+
last
3640
max
3741
mean
3842
min
@@ -41,6 +45,7 @@ Aggregations
4145
pivot_wider
4246
product
4347
quantile
48+
skew
4449
stddev
4550
sum
4651
tdigest
@@ -69,6 +74,7 @@ throws an ``ArrowInvalid`` exception when overflow is detected.
6974
cumulative_prod
7075
cumulative_prod_checked
7176
cumulative_max
77+
cumulative_mean
7278
cumulative_min
7379

7480
Arithmetic Functions
@@ -87,6 +93,8 @@ throws an ``ArrowInvalid`` exception when overflow is detected.
8793
add_checked
8894
divide
8995
divide_checked
96+
exp
97+
expm1
9098
multiply
9199
multiply_checked
92100
negate
@@ -126,6 +134,7 @@ representation based on the rounding criterion.
126134
ceil
127135
floor
128136
round
137+
round_binary
129138
round_to_multiple
130139
trunc
131140

@@ -171,6 +180,24 @@ variants which detect domain errors where appropriate.
171180
tan
172181
tan_checked
173182

183+
Hyperbolic Trigonometric Functions
184+
----------------------------------
185+
186+
Hyperbolic trigonometric functions are also supported, and, where applicable, also offer ``_checked``
187+
variants which detect domain errors if needed.
188+
189+
.. autosummary::
190+
:toctree: ../generated/
191+
192+
acosh
193+
acosh_checked
194+
asinh
195+
atanh
196+
atanh_checked
197+
cosh
198+
sinh
199+
tanh
200+
174201
Comparisons
175202
-----------
176203

@@ -281,6 +308,7 @@ String Transforms
281308
utf8_capitalize
282309
utf8_length
283310
utf8_lower
311+
utf8_normalize
284312
utf8_replace_slice
285313
utf8_reverse
286314
utf8_swapcase
@@ -338,6 +366,7 @@ String Component Extraction
338366
:toctree: ../generated/
339367

340368
extract_regex
369+
extract_regex_span
341370

342371
String Joining
343372
--------------
@@ -425,10 +454,11 @@ Temporal Component Extraction
425454
day_of_week
426455
day_of_year
427456
hour
457+
is_dst
458+
is_leap_year
428459
iso_week
429460
iso_year
430461
iso_calendar
431-
is_leap_year
432462
microsecond
433463
millisecond
434464
minute
@@ -472,12 +502,21 @@ Timezone Handling
472502
assume_timezone
473503
local_timestamp
474504

505+
Random Number Generation
506+
------------------------
507+
508+
.. autosummary::
509+
:toctree: ../generated/
510+
511+
random
512+
475513
Associative Transforms
476514
----------------------
477515

478516
.. autosummary::
479517
:toctree: ../generated/
480518

519+
dictionary_decode
481520
dictionary_encode
482521
unique
483522
value_counts
@@ -492,7 +531,9 @@ Selections
492531
array_take
493532
drop_null
494533
filter
534+
inverse_permutation
495535
take
536+
scatter
496537

497538
Sorts and Partitions
498539
--------------------
@@ -501,9 +542,22 @@ Sorts and Partitions
501542
:toctree: ../generated/
502543

503544
array_sort_indices
545+
bottom_k_unstable
504546
partition_nth_indices
547+
rank
548+
rank_normal
549+
rank_quantile
505550
select_k_unstable
506551
sort_indices
552+
top_k_unstable
553+
554+
Statistical Functions
555+
---------------------
556+
557+
.. autosummary::
558+
:toctree: ../generated/
559+
560+
winsorize
507561

508562
Structural Transforms
509563
---------------------
@@ -531,6 +585,7 @@ Pairwise Functions
531585
:toctree: ../generated/
532586

533587
pairwise_diff
588+
pairwise_diff_checked
534589

535590
Compute Options
536591
---------------
@@ -542,35 +597,42 @@ Compute Options
542597
AssumeTimezoneOptions
543598
CastOptions
544599
CountOptions
600+
CumulativeOptions
545601
CumulativeSumOptions
546602
DayOfWeekOptions
547603
DictionaryEncodeOptions
548604
ElementWiseAggregateOptions
549605
ExtractRegexOptions
606+
ExtractRegexSpanOptions
550607
FilterOptions
551608
IndexOptions
552609
JoinOptions
610+
ListFlattenOptions
553611
ListSliceOptions
554612
MakeStructOptions
555613
MapLookupOptions
556614
MatchSubstringOptions
557615
ModeOptions
558616
NullOptions
559617
PadOptions
560-
ZeroFillOptions
561618
PairwiseOptions
562619
PartitionNthOptions
563620
PivotWiderOptions
564621
QuantileOptions
622+
RandomOptions
623+
RankOptions
624+
RankQuantileOptions
565625
ReplaceSliceOptions
566626
ReplaceSubstringOptions
627+
RoundBinaryOptions
567628
RoundOptions
568629
RoundTemporalOptions
569630
RoundToMultipleOptions
570631
RunEndEncodeOptions
571632
ScalarAggregateOptions
572633
SelectKOptions
573634
SetLookupOptions
635+
SkewOptions
574636
SliceOptions
575637
SortOptions
576638
SplitOptions
@@ -581,16 +643,33 @@ Compute Options
581643
TakeOptions
582644
TDigestOptions
583645
TrimOptions
646+
Utf8NormalizeOptions
584647
VarianceOptions
585648
WeekOptions
649+
WinsorizeOptions
650+
ZeroFillOptions
651+
652+
Functions Registry
653+
------------------
654+
655+
.. autosummary::
656+
:toctree: ../generated/
657+
658+
call_function
659+
call_tabular_function
660+
get_function
661+
list_functions
586662

587663
User-Defined Functions
588664
----------------------
589665

590666
.. autosummary::
591667
:toctree: ../generated/
592668

669+
register_aggregate_function
593670
register_scalar_function
671+
register_tabular_function
672+
register_vector_function
594673
UdfContext
595674

596675
Expression Functions

0 commit comments

Comments
 (0)