Skip to content

Commit cf74b02

Browse files
LiXuanqijorisvandenbossche
authored andcommitted
DOC: Do not mention private classes in the documentation (#26997)
1 parent e27eea8 commit cf74b02

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

ci/code_checks.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,8 @@ fi
256256
### DOCSTRINGS ###
257257
if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
258258

259-
MSG='Validate docstrings (GL03, GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA05)' ; echo $MSG
260-
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA05
259+
MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA05)' ; echo $MSG
260+
$BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL04,GL05,GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA05
261261
RET=$(($RET + $?)) ; echo $MSG "DONE"
262262

263263
fi

pandas/core/generic.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
# able to share
5757
_shared_docs = dict()
5858
_shared_doc_kwargs = dict(
59-
axes='keywords for axes', klass='NDFrame',
59+
axes='keywords for axes', klass='Series/DataFrame',
6060
axes_single_arg='int or labels for object',
6161
args_transpose='axes to permute (int or label for object)',
6262
optional_by="""
@@ -1940,7 +1940,7 @@ def __array_wrap__(self, result, context=None):
19401940

19411941
def to_dense(self):
19421942
"""
1943-
Return dense representation of NDFrame (as opposed to sparse).
1943+
Return dense representation of Series/DataFrame (as opposed to sparse).
19441944
19451945
.. deprecated:: 0.25.0
19461946
@@ -9036,7 +9036,7 @@ def tshift(self, periods=1, freq=None, axis=0):
90369036
90379037
Returns
90389038
-------
9039-
shifted : NDFrame
9039+
shifted : Series/DataFrame
90409040
90419041
Notes
90429042
-----
@@ -10272,12 +10272,12 @@ def _find_valid_index(self, how):
1027210272
return idx
1027310273

1027410274
@Appender(_shared_docs['valid_index'] % {'position': 'first',
10275-
'klass': 'NDFrame'})
10275+
'klass': 'Series/DataFrame'})
1027610276
def first_valid_index(self):
1027710277
return self._find_valid_index('first')
1027810278

1027910279
@Appender(_shared_docs['valid_index'] % {'position': 'last',
10280-
'klass': 'NDFrame'})
10280+
'klass': 'Series/DataFrame'})
1028110281
def last_valid_index(self):
1028210282
return self._find_valid_index('last')
1028310283

pandas/core/groupby/groupby.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -630,14 +630,14 @@ def curried(x):
630630

631631
def get_group(self, name, obj=None):
632632
"""
633-
Construct NDFrame from group with provided name.
633+
Construct DataFrame from group with provided name.
634634
635635
Parameters
636636
----------
637637
name : object
638638
the name of the group to get as a DataFrame
639-
obj : NDFrame, default None
640-
the NDFrame to take the DataFrame out of. If
639+
obj : DataFrame, default None
640+
the DataFrame to take the DataFrame out of. If
641641
it is None, the object groupby was called on will
642642
be used
643643

0 commit comments

Comments
 (0)