Skip to content

Commit 7234265

Browse files
committed
More fixes - Sphinx build is clean now
1 parent 51a6f0d commit 7234265

File tree

3 files changed

+7
-8
lines changed

3 files changed

+7
-8
lines changed

spec/API_specification/dataframe_api/_types.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
from enum import Enum
2222

2323
array = TypeVar("array")
24-
DataFrame = TypeVar("DataFrame")
24+
Scalar = TypeVar("Scalar")
2525
device = TypeVar("device")
2626
dtype = TypeVar("dtype")
2727
SupportsDLPack = TypeVar("SupportsDLPack")

spec/API_specification/dataframe_api/dataframe_object.py

+2-4
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@
44
from .column_object import Column
55
from .groupby_object import GroupBy
66

7-
8-
__all__ = ["DataFrame"]
7+
from ._types import Scalar
98

109

11-
class Scalar:
12-
"A class to represent Python scalars"
10+
__all__ = ["DataFrame"]
1311

1412

1513
class DataFrame:

spec/conf.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,20 @@
6565
# them don't actually refer to anything that we have a document for.
6666
nitpick_ignore = [
6767
('py:class', 'array'),
68-
('py:class', 'dataframe'),
68+
('py:class', 'DataFrame'),
6969
('py:class', 'device'),
7070
('py:class', 'dtype'),
7171
('py:class', 'NestedSequence'),
7272
('py:class', 'collections.abc.Sequence'),
7373
('py:class', 'PyCapsule'),
7474
('py:class', 'enum.Enum'),
7575
('py:class', 'ellipsis'),
76+
('py:class', 'Scalar'),
7677
]
7778
# NOTE: this alias handling isn't used yet - added in anticipation of future
78-
# need based on array API aliases.
79+
# need based on dataframe API aliases.
7980
# In dataframe_object.py we have to use aliased names for some types because they
80-
# would otherwise refer back to method objects of array
81+
# would otherwise refer back to method objects of `dataframe`
8182
autodoc_type_aliases = {
8283
'dataframe': 'dataframe',
8384
'Device': 'device',

0 commit comments

Comments
 (0)