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