Repository navigation
Commit 4bcfe15
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1749,21 +1749,21 @@ class _Subsection: | |||
| 1749 | 1749 | default="white", | |
| 1750 | 1750 | type=":mpltype:`color`", | |
| 1751 | 1751 | validator=validate_color, | |
| 1752 | - description="The axes background color." | ||
| 1752 | + description="Axes background color." | ||
| 1753 | 1753 | ), | |
| 1754 | 1754 | _Param( | |
| 1755 | 1755 | "axes.edgecolor", | |
| 1756 | 1756 | default="black", | |
| 1757 | 1757 | type=":mpltype:`color`", | |
| 1758 | 1758 | validator=validate_color, | |
| 1759 | - description="The axes edge color." | ||
| 1759 | + description="Axes edge color." | ||
| 1760 | 1760 | ), | |
| 1761 | 1761 | _Param( | |
| 1762 | 1762 | "axes.linewidth", | |
| 1763 | 1763 | default=0.8, | |
| 1764 | 1764 | type=float, | |
| 1765 | 1765 | validator=validate_float, | |
| 1766 | - description="The axes edge line width." | ||
| 1766 | + description="Axes edge line width in points." | ||
| 1767 | 1767 | ), | |
| 1768 | 1768 | _Param( | |
| 1769 | 1769 | "axes.grid", | |
@@ -1777,7 +1777,7 @@ class _Subsection: | |||
| 1777 | 1777 | default="both", | |
| 1778 | 1778 | type=Literal["x", "y", "both"], | |
| 1779 | 1779 | validator=["x", "y", "both"], | |
| 1780 | - description="Which axis the grid should apply to." | ||
| 1780 | + description="On which axis the grid is displayed." | ||
| 1781 | 1781 | ), | |
| 1782 | 1782 | _Param( | |
| 1783 | 1783 | "axes.grid.which", | |
@@ -1791,82 +1791,86 @@ class _Subsection: | |||
| 1791 | 1791 | default="center", | |
| 1792 | 1792 | type=Literal["left", "center", "right"], | |
| 1793 | 1793 | validator=["left", "center", "right"], | |
| 1794 | - description="The alignment of the axes title." | ||
| 1794 | + description="Horizontal location of the axes title." | ||
| 1795 | 1795 | ), | |
| 1796 | 1796 | _Param( | |
| 1797 | 1797 | "axes.titlesize", | |
| 1798 | 1798 | default="large", | |
| 1799 | 1799 | type=_FontSizeType, | |
| 1800 | 1800 | validator=validate_fontsize, | |
| 1801 | - description="The font size of the axes title." | ||
| 1801 | + description="Font size of the axes title." | ||
| 1802 | 1802 | ), | |
| 1803 | 1803 | _Param( | |
| 1804 | 1804 | "axes.titleweight", | |
| 1805 | 1805 | default="normal", | |
| 1806 | 1806 | type=_FontWeightType, | |
| 1807 | 1807 | validator=validate_fontweight, | |
| 1808 | - description="The font weight of the axes title." | ||
| 1808 | + description="Font weight of the axes title." | ||
| 1809 | 1809 | ), | |
| 1810 | 1810 | _Param( | |
| 1811 | 1811 | "axes.titlecolor", | |
| 1812 | 1812 | default="auto", | |
| 1813 | 1813 | type=':mpltype:`color` or "auto"', | |
| 1814 | 1814 | validator=validate_color_or_auto, | |
| 1815 | - description="The color of the axes title; auto falls back to 'text.color'." | ||
| 1815 | + description="Color of the axes title; 'auto' falls back to 'text.color'." | ||
| 1816 | 1816 | ), | |
| 1817 | 1817 | _Param( | |
| 1818 | 1818 | "axes.titley", | |
| 1819 | 1819 | default=None, | |
| 1820 | 1820 | type=float | None, | |
| 1821 | 1821 | validator=validate_float_or_None, | |
| 1822 | - description="The vertical title position in " | ||
| 1823 | - ":ref:`axes coordinates <coordinate-systems>`; " | ||
| 1824 | - "None enables automatic placement." | ||
| 1822 | + description="Vertical axes title position.\n\n" | ||
| 1823 | + "A number specifies the text baseline in " | ||
| 1824 | + ":ref:`axes coordinates <coordinate-systems>`. " | ||
| 1825 | + "None enables automatic placement so that the title bottom aligns " | ||
| 1826 | + "with the top of the Axes and potentially any top tick " | ||
| 1827 | + "labels.\n\n" | ||
| 1828 | + "The position will additionally be shifted by 'axes.titlepad'." | ||
| 1825 | 1829 | ), | |
| 1826 | 1830 | _Param( | |
| 1827 | 1831 | "axes.titlepad", | |
| 1828 | 1832 | default=6.0, | |
| 1829 | 1833 | type=float, | |
| 1830 | 1834 | validator=validate_float, | |
| 1831 | - description="The padding between the axes and title, in points." | ||
| 1835 | + description="Additional space between the Axes and title in points. This " | ||
| 1836 | + "shifts the title position determined by 'axes.titley'. " | ||
| 1832 | 1837 | ), | |
| 1833 | 1838 | _Param( | |
| 1834 | 1839 | "axes.labelsize", | |
| 1835 | 1840 | default="medium", | |
| 1836 | 1841 | type=_FontSizeType, | |
| 1837 | 1842 | validator=validate_fontsize, | |
| 1838 | - description="The font size of the x and y labels." | ||
| 1843 | + description="Font size of the x and y labels." | ||
| 1839 | 1844 | ), | |
| 1840 | 1845 | _Param( | |
| 1841 | 1846 | "axes.labelpad", | |
| 1842 | 1847 | default=4.0, | |
| 1843 | 1848 | type=float, | |
| 1844 | 1849 | validator=validate_float, | |
| 1845 | - description="The space between the axis label and the axis, in points." | ||
| 1850 | + description="The space between the axis label and the axis / tick labels, " | ||
| 1851 | + "in points." | ||
| 1846 | 1852 | ), | |
| 1847 | 1853 | _Param( | |
| 1848 | 1854 | "axes.labelweight", | |
| 1849 | 1855 | default="normal", | |
| 1850 | 1856 | type=_FontWeightType, | |
| 1851 | 1857 | validator=validate_fontweight, | |
| 1852 | - description="The font weight of the x and y labels." | ||
| 1858 | + description="Font weight of the x and y labels." | ||
| 1853 | 1859 | ), | |
| 1854 | 1860 | _Param( | |
| 1855 | 1861 | "axes.labelcolor", | |
| 1856 | 1862 | default="black", | |
| 1857 | 1863 | type=":mpltype:`color`", | |
| 1858 | 1864 | validator=validate_color, | |
| 1859 | - description="The color of the axis labels." | ||
| 1865 | + description="Color of the axis labels." | ||
| 1860 | 1866 | ), | |
| 1861 | 1867 | _Param( | |
| 1862 | 1868 | "axes.axisbelow", | |
| 1863 | 1869 | default="line", | |
| 1864 | 1870 | type=bool | Literal["line"], | |
| 1865 | 1871 | validator=validate_axisbelow, | |
| 1866 | - description="draw axis gridlines and ticks: " | ||
| 1867 | - "- below patches (True) " | ||
| 1868 | - "- above patches but below lines ('line') " | ||
| 1869 | - "- above all (False)" | ||
| 1872 | + description="Whether axis ticks and gridlines are above or below most artists. " | ||
| 1873 | + "See `~.Axes.set_axisbelow` for details." | ||
| 1870 | 1874 | ), | |
| 1871 | 1875 | _Param( | |
| 1872 | 1876 | "axes.formatter.limits", | |
@@ -1881,22 +1885,26 @@ class _Subsection: | |||
| 1881 | 1885 | default=False, | |
| 1882 | 1886 | type=bool, | |
| 1883 | 1887 | validator=validate_bool, | |
| 1884 | - description="When True, format tick labels according to the user's locale. " | ||
| 1888 | + description="Whether to format tick labels according to the user's locale. " | ||
| 1885 | 1889 | "For example, use ',' as a decimal separator in the fr_FR locale." | |
| 1886 | 1890 | ), | |
| 1887 | 1891 | _Param( | |
| 1888 | 1892 | "axes.formatter.use_mathtext", | |
| 1889 | 1893 | default=False, | |
| 1890 | 1894 | type=bool, | |
| 1891 | 1895 | validator=validate_bool, | |
| 1892 | - description="When True, use mathtext for scientific notation." | ||
| 1896 | + description="Whether `.ScalarFormatter` and `.EngFormatter` use fancy " | ||
| 1897 | + r"formatting for scientific notation; i.e. :math:`1.2 \times 10^3` " | ||
| 1898 | + "instead of 1.2e3." | ||
| 1893 | 1899 | ), | |
| 1894 | 1900 | _Param( | |
| 1895 | 1901 | "axes.formatter.min_exponent", | |
| 1896 | 1902 | default=0, | |
| 1897 | 1903 | type=int, | |
| 1898 | 1904 | validator=validate_int, | |
| 1899 | - description="minimum exponent to format in scientific notation" | ||
| 1905 | + description="The smallest absolute exponent value that log formatters will " | ||
| 1906 | + "format as scientific notation; e.g. if set to 3, formatting will " | ||
| 1907 | + "1e-3, 0.01, 0.1, 0, 10, 100, 1e3." | ||
| 1900 | 1908 | ), | |
| 1901 | 1909 | _Param( | |
| 1902 | 1910 | "axes.formatter.useoffset", | |
@@ -1916,27 +1924,23 @@ class _Subsection: | |||
| 1916 | 1924 | "remove at least this number of significant digits from tick " | |
| 1917 | 1925 | "labels." | |
| 1918 | 1926 | ), | |
| 1919 | - _Param( | ||
| 1920 | - "axes.spines.left", | ||
| 1921 | - default=True, | ||
| 1922 | - type=bool, | ||
| 1923 | - validator=validate_bool, | ||
| 1924 | - description="display axis spines" | ||
| 1925 | - ), | ||
| 1926 | - _Param("axes.spines.bottom", True, bool, validate_bool, | ||
| 1927 | + _Param("axes.spines.left", default=True, type=bool, validator=validate_bool, | ||
| 1928 | + description="Whether to draw the left axis spine."), | ||
| 1929 | + _Param("axes.spines.bottom", default=True, type=bool, validator=validate_bool, | ||
| 1927 | 1930 | description="Whether to draw the bottom axis spine."), | |
| 1928 | - _Param("axes.spines.top", True, bool, validate_bool, | ||
| 1931 | + _Param("axes.spines.top", default=True, type=bool, validator=validate_bool, | ||
| 1929 | 1932 | description="Whether to draw the top axis spine."), | |
| 1930 | - _Param("axes.spines.right", True, bool, validate_bool, | ||
| 1933 | + _Param("axes.spines.right", default=True, type=bool, validator=validate_bool, | ||
| 1931 | 1934 | description="Whether to draw the right axis spine."), | |
| 1932 | 1935 | _Param( | |
| 1933 | 1936 | "axes.unicode_minus", | |
| 1934 | 1937 | default=True, | |
| 1935 | 1938 | type=bool, | |
| 1936 | 1939 | validator=validate_bool, | |
| 1937 | - description="use Unicode for the minus symbol rather than hyphen. See " | ||
| 1938 | - "https://en.wikipedia.org/wiki/Plus_and_minus_signs#Character_codes" | ||
| 1939 | - | ||
| 1940 | + description="Whether formatters will use the Unicode *Minus Sign* symbol " | ||
| 1941 | + "U+2212 (\N{MINUS SIGN}) rather than the ASCII hyphen U+002D (-) " | ||
| 1942 | + "for negative numbers. See also " | ||
| 1943 | + ":doc:`/gallery/text_labels_and_annotations/unicode_minus`." | ||
| 1940 | 1944 | ), | |
| 1941 | 1945 | _Param( | |
| 1942 | 1946 | "axes.prop_cycle", | |
@@ -1963,30 +1967,30 @@ class _Subsection: | |||
| 1963 | 1967 | default=0.05, | |
| 1964 | 1968 | type=float, | |
| 1965 | 1969 | validator=_validate_greaterthan_minushalf, | |
| 1966 | - description="x margin. See `~.axes.Axes.margins`" | ||
| 1970 | + description="x margin. See `~.axes.Axes.margins`." | ||
| 1967 | 1971 | ), | |
| 1968 | 1972 | _Param( | |
| 1969 | 1973 | "axes.ymargin", | |
| 1970 | 1974 | default=0.05, | |
| 1971 | 1975 | type=float, | |
| 1972 | 1976 | validator=_validate_greaterthan_minushalf, | |
| 1973 | - description="y margin. See `~.axes.Axes.margins`" | ||
| 1977 | + description="y margin. See `~.axes.Axes.margins`." | ||
| 1974 | 1978 | ), | |
| 1975 | 1979 | _Param( | |
| 1976 | 1980 | "axes.zmargin", | |
| 1977 | 1981 | default=0.05, | |
| 1978 | 1982 | type=float, | |
| 1979 | 1983 | validator=_validate_greaterthan_minushalf, | |
| 1980 | - description="z margin. See `~.axes.Axes.margins`" | ||
| 1984 | + description="z margin. See `~.axes.Axes.margins`." | ||
| 1981 | 1985 | ), | |
| 1982 | 1986 | _Param( | |
| 1983 | 1987 | "axes.autolimit_mode", | |
| 1984 | 1988 | default="data", | |
| 1985 | 1989 | type=Literal["data", "round_numbers"], | |
| 1986 | 1990 | validator=["data", "round_numbers"], | |
| 1987 | - description='If "data", use axes.xmargin and axes.ymargin as is. If ' | ||
| 1988 | - '"round_numbers", after application of margins, axis limits are ' | ||
| 1989 | - 'further expanded to the nearest "round" number.', | ||
| 1991 | + description='Whether autoscaling should try to adjust the view limits so that ' | ||
| 1992 | + 'there are ticks at the the axis edges. See ' | ||
| 1993 | + ':ref:`autoscaling-limit-rounding`.' | ||
| 1990 | 1994 | ), | |
| 1991 | 1995 | _Subsection("Polar Axes"), | |
| 1992 | 1996 | _Param( | |
0 commit comments