@@ -1721,14 +1721,23 @@ def keys(self):
1721
1721
"""
1722
1722
return self ._info_axis
1723
1723
1724
+ # @Substitution(klass=self.__name__, type_sub=" and column dtypes"*(self._typ
1725
+ # =='dataframe'),
1726
+ # max_cols_sub="""
1727
+ # max_cols : int, optional
1728
+ # When to switch from the verbose to the truncated output. If the
1729
+ # DataFrame has more than `max_cols` columns, the truncated output
1730
+ # is used. By default, the setting in
1731
+ # ``pandas.options.display.max_info_columns`` is used.
1732
+ # """*(self._typ=='dataframe'), )
1724
1733
def info (
1725
1734
self , verbose = None , buf = None , max_cols = None , memory_usage = None , null_counts = None
1726
1735
) -> None :
1727
1736
"""
1728
- Print a concise summary of a DataFrame .
1737
+ Print a concise summary of a %(klass)s .
1729
1738
1730
- This method prints information about a DataFrame including
1731
- the index dtype and column dtypes , non-null values and memory usage.
1739
+ This method prints information about a %(klass)s including
1740
+ the index dtype%(type_sub) , non-null values and memory usage.
1732
1741
1733
1742
Parameters
1734
1743
----------
@@ -1738,14 +1747,9 @@ def info(
1738
1747
buf : writable buffer, defaults to sys.stdout
1739
1748
Where to send the output. By default, the output is printed to
1740
1749
sys.stdout. Pass a writable buffer if you need to further process
1741
- the output.
1742
- max_cols : int, optional
1743
- When to switch from the verbose to the truncated output. If the
1744
- DataFrame has more than `max_cols` columns, the truncated output
1745
- is used. By default, the setting in
1746
- ``pandas.options.display.max_info_columns`` is used.
1750
+ the output.%(max_cols_sub)s
1747
1751
memory_usage : bool, str, optional
1748
- Specifies whether total memory usage of the DataFrame
1752
+ Specifies whether total memory usage of the %(klass)s
1749
1753
elements (including the index) should be displayed. By default,
1750
1754
this follows the ``pandas.options.display.memory_usage`` setting.
1751
1755
@@ -1759,21 +1763,21 @@ def info(
1759
1763
at the cost of computational resources.
1760
1764
null_counts : bool, optional
1761
1765
Whether to show the non-null counts. By default, this is shown
1762
- only if the frame is smaller than
1766
+ only if the %(klass)s is smaller than
1763
1767
``pandas.options.display.max_info_rows`` and
1764
1768
``pandas.options.display.max_info_columns``. A value of True always
1765
1769
shows the counts, and False never shows the counts.
1766
1770
1767
1771
Returns
1768
1772
-------
1769
1773
None
1770
- This method prints a summary of a DataFrame and returns None.
1774
+ This method prints a summary of a %(klass)s and returns None.
1771
1775
1772
1776
See Also
1773
1777
--------
1774
- DataFrame.describe: Generate descriptive statistics of DataFrame
1778
+ DataFrame.describe: Generate descriptive statistics of %(klass)s
1775
1779
columns.
1776
- DataFrame .memory_usage: Memory usage of DataFrame columns .
1780
+ %(klass)s .memory_usage: Memory usage of %(klass)s%(memory_sub)s .
1777
1781
1778
1782
Examples
1779
1783
--------
0 commit comments