Skip to content

Commit 9fde26d

Browse files
committed
Fix last warnings, and include Column in the same way as DataFrame
1 parent 6d36cfb commit 9fde26d

File tree

4 files changed

+18
-17
lines changed

4 files changed

+18
-17
lines changed

spec/API_specification/column_object.rst

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,9 @@ Column object
44
=============
55

66
A conforming implementation of the dataframe API standard must provide and
7-
support a column object having the following attributes and methods.
7+
support a column object having the following methods, attributes, and
8+
behavior.
89

9-
-------------------------------------------------
10-
11-
Methods
12-
-------
13-
TODO
14-
15-
..
16-
NOTE: please keep the methods in alphabetical order
17-
18-
.. currentmodule:: dataframe_api
19-
20-
.. autosummary::
21-
:toctree: generated
22-
:template: property.rst
10+
.. currentmodule:: dataframe_api
2311

12+
.. autoclass:: Column
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
1+
__all__ = ['Column']
2+
3+
14
class Column:
5+
"""
6+
Column object
7+
8+
Note that this column object is not meant to be instantiated directly by
9+
users of the library implementing the dataframe API standard. Rather, use
10+
constructor functions or an already-created dataframe object retrieved via
11+
12+
"""
213
pass

spec/API_specification/dataframe_api/dataframe_object.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ class DataFrame:
1414
"""
1515
DataFrame object
1616
17-
Note that this DataFrame object is not meant to be instantiated directly by
17+
Note that this dataframe object is not meant to be instantiated directly by
1818
users of the library implementing the dataframe API standard. Rather, use
1919
constructor functions or an already-created dataframe object retrieved via
2020
@@ -31,6 +31,8 @@ class DataFrame:
3131
In-place operators must not be supported. All operations on the dataframe
3232
object are out-of-place.
3333
34+
**Methods and Attributes**
35+
3436
"""
3537
@property
3638
def dataframe(self) -> object:

spec/API_specification/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ API specification
44
.. currentmodule:: dataframe_api
55

66
.. toctree::
7-
:caption: API specification
87
:maxdepth: 3
98

109
dataframe_object

0 commit comments

Comments
 (0)