DOC: Some changes #17992
DOC: Some changes #17992
Conversation
TomAugspurger
commented
Oct 26, 2017
TomAugspurger
commented
- Added whatsnew templates for 0.21.1 and 0.22.0
- Update release.rst and whatsnew/v0.21.0.txt for the release tomorrow
- Fixed some broken references in the 0.21.0 whatsnew
doc/source/whatsnew/v0.21.0.txt
Outdated
| @@ -29,13 +29,14 @@ New features | |||
| ~~~~~~~~~~~~ | |||
|
|
|||
| - Support for `PEP 519 -- Adding a file system path protocol | |||
| <https://www.python.org/dev/peps/pep-0519/>`_ on most readers and writers (:issue:`13823`) | |||
| <https://www.python.org/dev/peps/pep-0519/>`_ on most readers (e.g. | |||
| :func:`pd.read_csv`) and writers (e.g. :meth:`DataFrame.to_csv`) (:issue:`13823`). | |||
There was a problem hiding this comment.
Should the "pd." be removed in :func:`pd.read_csv`?
doc/source/whatsnew/v0.21.0.txt
Outdated
| @@ -263,16 +264,16 @@ Other Enhancements | |||
| - Integration with `Apache Parquet <https://parquet.apache.org/>`__, including a new top-level :func:`read_parquet` and :func:`DataFrame.to_parquet` method, see :ref:`here <io.parquet>`. (:issue:`15838`, :issue:`17438`) | |||
| - :func:`DataFrame.add_prefix` and :func:`DataFrame.add_suffix` now accept strings containing the '%' character. (:issue:`17151`) | |||
| - Read/write methods that infer compression (:func:`read_csv`, :func:`read_table`, :func:`read_pickle`, and :meth:`~DataFrame.to_pickle`) can now infer from path-like objects, such as ``pathlib.Path``. (:issue:`17206`) | |||
| - :func:`pd.read_sas()` now recognizes much more of the most frequently used date (datetime) formats in SAS7BDAT files. (:issue:`15871`) | |||
| - :func:`read_sas()` now recognizes much more of the most frequently used date (datetime) formats in SAS7BDAT files. (:issue:`15871`) | |||
There was a problem hiding this comment.
Should there be parenthesis in :func:`read_sas()`? Usually don't see parenthesis used with :func:, but I'm not super familiar with this, so it may still render fine.
doc/source/whatsnew/v0.21.0.txt
Outdated
| - Added ``skipna`` parameter to :func:`~pandas.api.types.infer_dtype` to | ||
| support type inference in the presence of missing values (:issue:`17059`). | ||
| - :class:`~pandas.Resampler.nearest` is added to support nearest-neighbor upsampling (:issue:`17496`). | ||
| - :class:`~pandas.Index` has added support for a ``to_frame`` method (:issue:`15230`) | ||
| - :class:`~pandas.core.resample.Resampler.nearest` is added to support nearest-neighbor upsampling (:issue:`17496`). |
There was a problem hiding this comment.
Should this be :meth: instead of :class:?
|
Thanks @jschendel, you're right on all counts I think. |
Codecov Report
@@ Coverage Diff @@
## master #17992 +/- ##
==========================================
- Coverage 91.23% 91.22% -0.02%
==========================================
Files 163 163
Lines 50113 50113
==========================================
- Hits 45723 45714 -9
- Misses 4390 4399 +9
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #17992 +/- ##
==========================================
- Coverage 91.26% 91.22% -0.05%
==========================================
Files 163 163
Lines 50117 50117
==========================================
- Hits 45739 45718 -21
- Misses 4378 4399 +21
Continue to review full report at Codecov.
|
doc/source/api.rst
Outdated
| @@ -95,6 +97,7 @@ HDFStore: PyTables (HDF5) | |||
| :toctree: generated/ | |||
|
|
|||
| read_hdf | |||
| HDFStore | |||
There was a problem hiding this comment.
This will also document all methods/attributes (and not all of them are documented in the user guide I think). Not familiar with this part of the code, but just wondering to what extent we need to publicize them (by having html docstring pages for them and listed on the HDFStore page)
(could also use the class_without_autosummary)
There was a problem hiding this comment.
Oh right, I forgot we included everything. The only reason I included it was since I referenced it about the __fspath__ stuff, but that alone isn't a good enough reason. I'll just remove them and the references for now. I really just want the class docstring, but we can do that later.
doc/source/whatsnew/v0.21.1.txt
Outdated
| .. _whatsnew_0211.api_breaking: | ||
|
|
||
| Backwards incompatible API changes | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
There should be no breaking changes in 0.21.1
(I know there can be if needed, but we should not encourage ourselves :-))
| .. _whatsnew_0211.bug_fixes: | ||
|
|
||
| Bug Fixes | ||
| ~~~~~~~~~ |
There was a problem hiding this comment.
can you add some blank lines in each of the bug fix sub-sectios (and some of the other sections as well). this helps prevent conflicts (if people don't all pick the same line).
1. Added whatsnew templates for 0.21.1 and 0.22.0 2. Update release.rst and whatsnew/v0.21.0.txt for the release tomorrow 3. Fixed some broken references in the 0.21.0 whatsnew
TomAugspurger
force-pushed
the
doc-templates
branch
from
611c6d5
to
ae74a92
Compare
1. Added whatsnew templates for 0.21.1 and 0.22.0 2. Update release.rst and whatsnew/v0.21.0.txt for the release tomorrow 3. Fixed some broken references in the 0.21.0 whatsnew
1. Added whatsnew templates for 0.21.1 and 0.22.0 2. Update release.rst and whatsnew/v0.21.0.txt for the release tomorrow 3. Fixed some broken references in the 0.21.0 whatsnew
