DOC: Fix grammar and formatting typos #14803
Conversation
| @@ -3583,8 +3583,8 @@ def replace(self, to_replace=None, value=None, inplace=False, limit=None, | |||
| wrappers around the scipy interpolation methods of similar | |||
| names. These use the actual numerical values of the index. See | |||
| the scipy documentation for more on their behavior | |||
| `here <http://docs.scipy.org/doc/scipy/reference/interpolate.html#univariate-interpolation>`__ # noqa | |||
| `and here <http://docs.scipy.org/doc/scipy/reference/tutorial/interpolate.html>`__ # noqa | |||
There was a problem hiding this comment.
I think this will give a problem with out linter (that's the reason for the "#noqa"), but can wait on travis to confirm.
A way how I have solved this in other places is to ensure there are no spaces on the line that is too long (then the linter makes an exception). So you can do:
... `here
<http://docs.scipy.org/doc/scipy/reference/interpolate.html#univariate-interpolation>`__
and then it does not complain about the too long line (this is also how it is done in some of the 'Notes' sections below
There was a problem hiding this comment.
Content wise, it maybe also nicer instead of "See the scipy documention for more on their behaviour here and here" to read "For more on their behaviour see the scipy reference and tutorial documentation" (then the difference between the two 'here's is more clear)
|
@mroeschke Thanks for the PR! Just one comment about the line length (our strict rules nowadays are sometimes a bit cumbersome for the docstrings ..) |
|
Ah you were correct; Travis threw a linting error. Thanks for the tips and explanation about #noqa! I'll fix those tonight. |
mroeschke
force-pushed
the
docstring_typos
branch
from
de40ebb to
52633cd
Compare
Current coverage is 85.28% (diff: 100%)@@ master #14803 diff @@
==========================================
Files 144 144
Lines 50968 50968
Methods 0 0
Messages 0 0
Branches 0 0
==========================================
+ Hits 43466 43467 +1
+ Misses 7502 7501 -1
Partials 0 0
|
|
@mroeschke the linter is now complaining about some other lines: (also lines that you didn't change, but I suppose that the |
|
Oops. Thanks for the heads up. I'll address those tonight as well. |
mroeschke
force-pushed
the
docstring_typos
branch
from
52633cd to
f2b6fbe
Compare
|
Hmm |
|
Yep (you can always look at the travis log (third build): https://travis-ci.org/pandas-dev/pandas/jobs/181861282, scroll to bottom): pandas/core/generic.py:3662:80: E501 line too long (80 > 79 characters) It's from lines that you didn't touch yourself (the full docstring was not checked before), so checking the diff didn't catch this. BTW, besides checking the diff manually, I would also advice to set up your IDE to check for this. |
|
Ah, thanks for the guidance! Still learning to navigate myself through the logs. I appreciate the help! |
Fix broken hyperlink on resample colon spacing remove comment from printing to docstring address linting errors pep8 fixes pep8 changes
mroeschke
force-pushed
the
docstring_typos
branch
from
f2b6fbe to
e08d27e
Compare
|
@mroeschke Thanks! |
* commit 'v0.19.0-174-g81a2f79': (156 commits) BLD: escape GH_TOKEN in build_docs TST: Correct results with np.size and crosstab (pandas-dev#4003) (pandas-dev#14755) Frame benchmarking sum instead of mean (pandas-dev#14824) CLN: lint of test_base.py BUG: Allow TZ-aware DatetimeIndex in merge_asof() (pandas-dev#14844) BUG: GH11847 Unstack with mixed dtypes coerces everything to object TST: skip testing on windows for specific formatting which sometimes hangs (pandas-dev#14851) BLD: try new gh token for pandas-docs CLN/PERF: clean-up of the benchmarks (pandas-dev#14099) ENH: add timedelta as valid type for interpolate with method='time' (pandas-dev#14799) DOC: add section on groupby().rolling/expanding/resample (pandas-dev#14801) TST: add test to confirm GH14606 (specify category dtype for empty) (pandas-dev#14752) BLD: use org name in build-docs.sh BF(TST): use = (native) instead of < (little endian) for target data types (pandas-dev#14832) ENH: Introduce UnsortedIndexError GH11897 (pandas-dev#14762) ENH: Add the ability to have a separate title for each subplot when plotting (pandas-dev#14753) DOC: Fix grammar and formatting typos (pandas-dev#14803) BLD: try new build credentials for pandas-docs TST: Test pivot with categorical data MAINT: Cleanup pandas/src/parser (pandas-dev#14740) ...
release 0.19.1 was from release branch * releases: (156 commits) BLD: escape GH_TOKEN in build_docs TST: Correct results with np.size and crosstab (pandas-dev#4003) (pandas-dev#14755) Frame benchmarking sum instead of mean (pandas-dev#14824) CLN: lint of test_base.py BUG: Allow TZ-aware DatetimeIndex in merge_asof() (pandas-dev#14844) BUG: GH11847 Unstack with mixed dtypes coerces everything to object TST: skip testing on windows for specific formatting which sometimes hangs (pandas-dev#14851) BLD: try new gh token for pandas-docs CLN/PERF: clean-up of the benchmarks (pandas-dev#14099) ENH: add timedelta as valid type for interpolate with method='time' (pandas-dev#14799) DOC: add section on groupby().rolling/expanding/resample (pandas-dev#14801) TST: add test to confirm GH14606 (specify category dtype for empty) (pandas-dev#14752) BLD: use org name in build-docs.sh BF(TST): use = (native) instead of < (little endian) for target data types (pandas-dev#14832) ENH: Introduce UnsortedIndexError GH11897 (pandas-dev#14762) ENH: Add the ability to have a separate title for each subplot when plotting (pandas-dev#14753) DOC: Fix grammar and formatting typos (pandas-dev#14803) BLD: try new build credentials for pandas-docs TST: Test pivot with categorical data MAINT: Cleanup pandas/src/parser (pandas-dev#14740) ...
One grammatical typo, and the rest address small formatting typos when rendering online.