Commit 3d59c95
committed
Docstring cleanups around DATA_PARAMETER_PLACEHOLDER.
- `[notes section required to get data note injection right]` has been
obsoleted by DATA_PARAMETER_PLACEHOLDER; get rid of them.
- loglog, semilogx, semilogy are thin wrappers around plot; it seems
fine to not document data there and leave it implicitly part of
`**kwargs: all parameters supported by plot`. Then "Other Parameters"
only contains `**kwargs` whose description is quite short, so it can
just be lifted into the main Parameters section rather than requiring
a separate section just for itself.
- Likewise for `step`, but that method actually explicitly lists `data`
in its signature, so just move its (already existing) description down
to its correct position.
This change was motivated by the fact that DATA_PARAMETER_PLACEHOLDER is
not correctly handled for these simple plot() wrappers; because they all
operate without going through _preprocess_data(), fixing them would also
require their own ad-hoc solution anyways.1 parent ef8692b commit 3d59c95
1 file changed
+15
-47
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1745 | 1745 | | |
1746 | 1746 | | |
1747 | 1747 | | |
| 1748 | + | |
| 1749 | + | |
| 1750 | + | |
1748 | 1751 | | |
1749 | 1752 | | |
1750 | 1753 | | |
1751 | 1754 | | |
1752 | | - | |
1753 | | - | |
1754 | | - | |
1755 | | - | |
1756 | | - | |
1757 | | - | |
1758 | | - | |
1759 | | - | |
1760 | 1755 | | |
1761 | 1756 | | |
1762 | 1757 | | |
| |||
1801 | 1796 | | |
1802 | 1797 | | |
1803 | 1798 | | |
| 1799 | + | |
| 1800 | + | |
| 1801 | + | |
1804 | 1802 | | |
1805 | 1803 | | |
1806 | 1804 | | |
1807 | 1805 | | |
1808 | | - | |
1809 | | - | |
1810 | | - | |
1811 | | - | |
1812 | | - | |
1813 | | - | |
1814 | | - | |
1815 | | - | |
1816 | 1806 | | |
1817 | 1807 | | |
1818 | 1808 | | |
| |||
1853 | 1843 | | |
1854 | 1844 | | |
1855 | 1845 | | |
| 1846 | + | |
| 1847 | + | |
| 1848 | + | |
1856 | 1849 | | |
1857 | 1850 | | |
1858 | 1851 | | |
1859 | 1852 | | |
1860 | | - | |
1861 | | - | |
1862 | | - | |
1863 | | - | |
1864 | | - | |
1865 | | - | |
1866 | | - | |
1867 | | - | |
1868 | 1853 | | |
1869 | 1854 | | |
1870 | 1855 | | |
| |||
2098 | 2083 | | |
2099 | 2084 | | |
2100 | 2085 | | |
2101 | | - | |
2102 | | - | |
2103 | | - | |
2104 | | - | |
2105 | 2086 | | |
2106 | 2087 | | |
2107 | 2088 | | |
| |||
2113 | 2094 | | |
2114 | 2095 | | |
2115 | 2096 | | |
2116 | | - | |
2117 | | - | |
2118 | | - | |
2119 | | - | |
2120 | | - | |
2121 | | - | |
2122 | | - | |
2123 | 2097 | | |
2124 | | - | |
| 2098 | + | |
| 2099 | + | |
2125 | 2100 | | |
2126 | 2101 | | |
2127 | 2102 | | |
2128 | 2103 | | |
2129 | | - | |
2130 | | - | |
2131 | | - | |
| 2104 | + | |
| 2105 | + | |
| 2106 | + | |
| 2107 | + | |
2132 | 2108 | | |
2133 | 2109 | | |
2134 | 2110 | | |
| |||
5148 | 5124 | | |
5149 | 5125 | | |
5150 | 5126 | | |
5151 | | - | |
5152 | | - | |
5153 | | - | |
5154 | | - | |
5155 | 5127 | | |
5156 | 5128 | | |
5157 | 5129 | | |
| |||
6227 | 6199 | | |
6228 | 6200 | | |
6229 | 6201 | | |
6230 | | - | |
6231 | | - | |
6232 | | - | |
6233 | | - | |
6234 | 6202 | | |
6235 | 6203 | | |
6236 | 6204 | | |
| |||
0 commit comments