Skip to content

Commit 4b76f5e

Browse files
committed
refinement
1 parent 592fb43 commit 4b76f5e

File tree

6 files changed

+25
-22
lines changed

6 files changed

+25
-22
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ instance/
7272
# Sphinx documentation
7373
docs/_build/
7474
_readthedocs/
75+
docs/reference/api/
7576

7677
# PyBuilder
7778
target/

docs/reference.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
API Reference (Test)
1+
API Reference
22
========================================================================================
33

44
.. toctree::
55
:maxdepth: 2
66

77
NestedFrame <reference/nestedframe>
88
.nest Accessor <reference/accessor>
9-
NestedDtype <reference/nesteddtype>
10-
Datasets <reference/datasets>
119
Utility Functions <reference/utils>
10+
NestedDtype <reference/nesteddtype>
1211
Nested Extension Array <reference/ext_array>
1312
Packer Functions <reference/packer>

docs/reference/datasets.rst

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/reference/nestedframe.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,16 @@ Nesting
1919
NestedFrame.from_flat
2020
NestedFrame.from_lists
2121

22-
Extended Pandas Interface
23-
~~~~~~~~~
22+
Extended Pandas.DataFrame Interface
23+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
24+
25+
.. note::
26+
The NestedFrame extends the Pandas.DataFrame interface, so all methods
27+
of Pandas.DataFrame are available. The following methods are extended
28+
to support NestedFrame functionality. Please reference the Pandas
29+
documentation for more information.
30+
https://pandas.pydata.org/docs/reference/frame.html
31+
2432
.. autosummary::
2533
:toctree: api/
2634

docs/reference/utils.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,17 @@ Utility Functions
33
=========
44
.. currentmodule:: nested_pandas
55

6-
Functions
6+
NestedFrame Utilities
77
~~~~~~~~~
88
.. autosummary::
99
:toctree: api/
1010

11-
utils.count_nested
11+
utils.count_nested
12+
13+
Generating Toy Datasets
14+
~~~~~~~~~
15+
.. autosummary::
16+
:toctree: api/
17+
18+
datasets.generation.generate_data
19+
datasets.generation.generate_parquet_file

src/nested_pandas/nestedframe/core.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -370,13 +370,12 @@ def from_lists(cls, df, base_columns=None, list_columns=None, name="nested"):
370370
NestedFrame
371371
A NestedFrame with the specified nesting structure.
372372
373-
Examples
373+
Examples
374374
--------
375375
376376
>>> nf = NestedFrame({"c":[1,2,3], "d":[2,4,6],
377377
... "e":[[1,2,3], [4,5,6], [7,8,9]]},
378-
... index=[0,1,2])
379-
378+
... index=[0,1,2])
380379
381380
>>> NestedFrame.from_lists(nf, base_columns=["c","d"])
382381
"""

0 commit comments

Comments
 (0)