Skip to content

Commit 257fc8a

Browse files
committed
[WIP]: API doc
1 parent 500ab71 commit 257fc8a

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

doc/source/api.rst

+56-1
Original file line numberDiff line numberDiff line change
@@ -701,6 +701,7 @@ adding ordering information or special categories is need at creation time of th
701701
Categorical.categories
702702
Categorical.ordered
703703
Categorical.codes
704+
Categorical.dtype
704705
Categorical.from_codes
705706

706707
``np.asarray(categorical)`` works by implementing the array interface. Be aware, that this converts
@@ -801,11 +802,14 @@ Attributes and underlying data
801802
DataFrame.get_ftype_counts
802803
DataFrame.select_dtypes
803804
DataFrame.values
805+
DataFrame.get_values
804806
DataFrame.axes
805807
DataFrame.ndim
806808
DataFrame.size
807809
DataFrame.shape
808810
DataFrame.memory_usage
811+
DataFrame.empty
812+
DataFrame.is_copy
809813

810814
Conversion
811815
~~~~~~~~~~
@@ -818,6 +822,7 @@ Conversion
818822
DataFrame.copy
819823
DataFrame.isna
820824
DataFrame.notna
825+
DataFrame.bool
821826

822827
Indexing, iteration
823828
~~~~~~~~~~~~~~~~~~~
@@ -830,14 +835,18 @@ Indexing, iteration
830835
DataFrame.loc
831836
DataFrame.iloc
832837
DataFrame.insert
838+
DataFrame.insert
833839
DataFrame.__iter__
840+
DataFrame.items
841+
DataFrame.keys
834842
DataFrame.iteritems
835843
DataFrame.iterrows
836844
DataFrame.itertuples
837845
DataFrame.lookup
838846
DataFrame.pop
839847
DataFrame.tail
840848
DataFrame.xs
849+
DataFrame.get
841850
DataFrame.isin
842851
DataFrame.where
843852
DataFrame.mask
@@ -854,12 +863,16 @@ Binary operator functions
854863

855864
DataFrame.add
856865
DataFrame.sub
866+
DataFrame.subtract
857867
DataFrame.mul
868+
DataFrame.multiply
858869
DataFrame.div
870+
DataFrame.divide
859871
DataFrame.truediv
860872
DataFrame.floordiv
861873
DataFrame.mod
862874
DataFrame.pow
875+
DataFrame.dot
863876
DataFrame.radd
864877
DataFrame.rsub
865878
DataFrame.rmul
@@ -884,6 +897,8 @@ Function application, GroupBy & Window
884897

885898
DataFrame.apply
886899
DataFrame.applymap
900+
DataFrame.pipe
901+
DataFrame.agg
887902
DataFrame.aggregate
888903
DataFrame.transform
889904
DataFrame.groupby
@@ -904,6 +919,7 @@ Computations / Descriptive Stats
904919
DataFrame.clip
905920
DataFrame.clip_lower
906921
DataFrame.clip_upper
922+
DataFrame.compound
907923
DataFrame.corr
908924
DataFrame.corrwith
909925
DataFrame.count
@@ -916,6 +932,7 @@ Computations / Descriptive Stats
916932
DataFrame.diff
917933
DataFrame.eval
918934
DataFrame.kurt
935+
DataFrame.kurtosis
919936
DataFrame.mad
920937
DataFrame.max
921938
DataFrame.mean
@@ -924,6 +941,7 @@ Computations / Descriptive Stats
924941
DataFrame.mode
925942
DataFrame.pct_change
926943
DataFrame.prod
944+
DataFrame.product
927945
DataFrame.quantile
928946
DataFrame.rank
929947
DataFrame.round
@@ -932,6 +950,7 @@ Computations / Descriptive Stats
932950
DataFrame.sum
933951
DataFrame.std
934952
DataFrame.var
953+
DataFrame.nunique
935954

936955
Reindexing / Selection / Label manipulation
937956
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -941,6 +960,8 @@ Reindexing / Selection / Label manipulation
941960
DataFrame.add_prefix
942961
DataFrame.add_suffix
943962
DataFrame.align
963+
DataFrame.at_time
964+
DataFrame.between_time
944965
DataFrame.drop
945966
DataFrame.drop_duplicates
946967
DataFrame.duplicated
@@ -959,6 +980,7 @@ Reindexing / Selection / Label manipulation
959980
DataFrame.reset_index
960981
DataFrame.sample
961982
DataFrame.select
983+
DataFrame.set_axis
962984
DataFrame.set_index
963985
DataFrame.tail
964986
DataFrame.take
@@ -974,13 +996,17 @@ Missing data handling
974996
DataFrame.dropna
975997
DataFrame.fillna
976998
DataFrame.replace
999+
DataFrame.interpolate
1000+
DataFrame.isnull
1001+
DataFrame.notnull
9771002

9781003
Reshaping, sorting, transposing
9791004
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9801005
.. autosummary::
9811006
:toctree: generated/
9821007

9831008
DataFrame.pivot
1009+
DataFrame.pivot_table
9841010
DataFrame.reorder_levels
9851011
DataFrame.sort_values
9861012
DataFrame.sort_index
@@ -989,10 +1015,12 @@ Reshaping, sorting, transposing
9891015
DataFrame.swaplevel
9901016
DataFrame.stack
9911017
DataFrame.unstack
1018+
DataFrame.swapaxes
9921019
DataFrame.melt
993-
DataFrame.T
1020+
DataFrame.squeeze
9941021
DataFrame.to_panel
9951022
DataFrame.to_xarray
1023+
DataFrame.T
9961024
DataFrame.transpose
9971025

9981026
Combining / joining / merging
@@ -1014,6 +1042,8 @@ Time series-related
10141042
DataFrame.asfreq
10151043
DataFrame.asof
10161044
DataFrame.shift
1045+
DataFrame.slice_shift
1046+
DataFrame.tshift
10171047
DataFrame.first_valid_index
10181048
DataFrame.last_valid_index
10191049
DataFrame.resample
@@ -1068,6 +1098,7 @@ Serialization / IO / Conversion
10681098
DataFrame.from_items
10691099
DataFrame.from_records
10701100
DataFrame.info
1101+
DataFrame.to_parquet
10711102
DataFrame.to_pickle
10721103
DataFrame.to_csv
10731104
DataFrame.to_hdf
@@ -1086,6 +1117,7 @@ Serialization / IO / Conversion
10861117
DataFrame.to_dense
10871118
DataFrame.to_string
10881119
DataFrame.to_clipboard
1120+
DataFrame.style
10891121

10901122
Sparse
10911123
~~~~~~
@@ -2313,3 +2345,26 @@ Scalar introspection
23132345
api.types.is_re
23142346
api.types.is_re_compilable
23152347
api.types.is_scalar
2348+
2349+
2350+
.. This is to prevent warnings in the doc build. We don't want to encourage
2351+
.. these methods.
2352+
2353+
.. toctree::
2354+
:hidden:
2355+
2356+
generated/pandas.DataFrame.as_blocks
2357+
generated/pandas.DataFrame.ffill
2358+
generated/pandas.DataFrame.bfill
2359+
generated/pandas.DataFrame.blocks
2360+
generated/pandas.DataFrame.sortlevel
2361+
generated/pandas.DataFrame.consolidate
2362+
generated/pandas.DataFrame.set_value
2363+
generated/pandas.DataFrame.get_value
2364+
2365+
generated/pandas.Series.as_blocks
2366+
generated/pandas.Series.ffill
2367+
generated/pandas.Series.bfill
2368+
generated/pandas.Series.set_value
2369+
generated/pandas.Series.get_value
2370+
generated/pandas.Series.blocks

0 commit comments

Comments
 (0)