DOC: Do not mention private classes in the documentation (#26997)

Author: LiXuanqi

ci/code_checks.sh

@@ -256,8 +256,8 @@ fi
 ### DOCSTRINGS ###
 if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
 
- MSG='Validate docstrings (GL03, GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA05)' ; echo $MSG
- $BASE_DIR/scripts/validate_docstrings.py --format=azure --errors=GL03,GL06,GL07,GL09,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA05
+ MSG='Validate docstrings (GL03, GL04, GL05, GL06, GL07, GL09, SS04, SS05, PR03, PR04, PR05, PR10, EX04, RT01, RT04, RT05, SA05)' ; echo $MSG
+ $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
  RET=$(($RET + $?)) ; echo $MSG "DONE"
 
 fi

pandas/core/generic.py

@@ -56,7 +56,7 @@
 # able to share
 _shared_docs = dict()
 _shared_doc_kwargs = dict(
- axes='keywords for axes', klass='NDFrame',
+ axes='keywords for axes', klass='Series/DataFrame',
  axes_single_arg='int or labels for object',
  args_transpose='axes to permute (int or label for object)',
  optional_by="""
@@ -1940,7 +1940,7 @@ def __array_wrap__(self, result, context=None):
 
  def to_dense(self):
  """
- Return dense representation of NDFrame (as opposed to sparse).
+ Return dense representation of Series/DataFrame (as opposed to sparse).
 
  .. deprecated:: 0.25.0
 
@@ -9036,7 +9036,7 @@ def tshift(self, periods=1, freq=None, axis=0):
 
  Returns
  -------
- shifted : NDFrame
+ shifted : Series/DataFrame
 
  Notes
  -----
@@ -10272,12 +10272,12 @@ def _find_valid_index(self, how):
  return idx
 
  @Appender(_shared_docs['valid_index'] % {'position': 'first',
- 'klass': 'NDFrame'})
+ 'klass': 'Series/DataFrame'})
  def first_valid_index(self):
  return self._find_valid_index('first')
 
  @Appender(_shared_docs['valid_index'] % {'position': 'last',
- 'klass': 'NDFrame'})
+ 'klass': 'Series/DataFrame'})
  def last_valid_index(self):
  return self._find_valid_index('last')
 

pandas/core/groupby/groupby.py

@@ -630,14 +630,14 @@ def curried(x):
 
  def get_group(self, name, obj=None):
  """
- Construct NDFrame from group with provided name.
+ Construct DataFrame from group with provided name.
 
  Parameters
  ----------
  name : object
  the name of the group to get as a DataFrame
- obj : NDFrame, default None
- the NDFrame to take the DataFrame out of. If
+ obj : DataFrame, default None
+ the DataFrame to take the DataFrame out of. If
  it is None, the object groupby was called on will
  be used