-
-
Notifications
You must be signed in to change notification settings - Fork 17.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC: Update Sphinx Deprecated Directive #16512
Merged
jorisvandenbossche
merged 9 commits into
pandas-dev:master
from
GuessWhoSamFoo:sphinx_deprecate
Jun 27, 2017
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
4c73c42
DOC: Added sphinx deprecated directive XR#6581
GuessWhoSamFoo 400bb40
Fixed whitespace
GuessWhoSamFoo 135f8d0
Removed references to future versions
GuessWhoSamFoo 7fccb78
Updated per comments
GuessWhoSamFoo 9f945c2
Rendered HTML using sphinx to check output
GuessWhoSamFoo 5d8db3f
Resolve merge conflicts
GuessWhoSamFoo c281c04
Merge branch 'master' into sphinx_deprecate
GuessWhoSamFoo 4dcab50
Restored deleted file; updated per comments
GuessWhoSamFoo 8f31b83
Merge branch 'sphinx_deprecate' of github.com:GuessWhoSamFoo/pandas i…
GuessWhoSamFoo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -137,8 +137,10 @@ usecols : array-like or callable, default ``None`` | |
|
||
Using this parameter results in much faster parsing time and lower memory usage. | ||
as_recarray : boolean, default ``False`` | ||
DEPRECATED: this argument will be removed in a future version. Please call | ||
``pd.read_csv(...).to_records()`` instead. | ||
|
||
.. deprecated:: 0.18.2 | ||
|
||
Please call ``pd.read_csv(...).to_records()`` instead. | ||
|
||
Return a NumPy recarray instead of a DataFrame after parsing the data. If | ||
set to ``True``, this option takes precedence over the ``squeeze`` parameter. | ||
|
@@ -191,7 +193,11 @@ skiprows : list-like or integer, default ``None`` | |
skipfooter : int, default ``0`` | ||
Number of lines at bottom of file to skip (unsupported with engine='c'). | ||
skip_footer : int, default ``0`` | ||
DEPRECATED: use the ``skipfooter`` parameter instead, as they are identical | ||
|
||
.. deprecated:: 0.19.0 | ||
|
||
Use the ``skipfooter`` parameter instead, as they are identical | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. e.g. this like this |
||
|
||
nrows : int, default ``None`` | ||
Number of rows of file to read. Useful for reading pieces of large files. | ||
low_memory : boolean, default ``True`` | ||
|
@@ -202,16 +208,25 @@ low_memory : boolean, default ``True`` | |
use the ``chunksize`` or ``iterator`` parameter to return the data in chunks. | ||
(Only valid with C parser) | ||
buffer_lines : int, default None | ||
DEPRECATED: this argument will be removed in a future version because its | ||
value is not respected by the parser | ||
|
||
.. deprecated:: 0.19.0 | ||
|
||
Argument removed because its value is not respected by the parser | ||
|
||
compact_ints : boolean, default False | ||
DEPRECATED: this argument will be removed in a future version | ||
|
||
.. deprecated:: 0.19.0 | ||
|
||
Argument moved to ``pd.to_numeric`` | ||
|
||
If ``compact_ints`` is ``True``, then for any column that is of integer dtype, the | ||
parser will attempt to cast it as the smallest integer ``dtype`` possible, either | ||
signed or unsigned depending on the specification from the ``use_unsigned`` parameter. | ||
use_unsigned : boolean, default False | ||
DEPRECATED: this argument will be removed in a future version | ||
|
||
.. deprecated:: 0.18.2 | ||
|
||
Argument moved to ``pd.to_numeric`` | ||
|
||
If integer columns are being compacted (i.e. ``compact_ints=True``), specify whether | ||
the column should be compacted to the smallest signed or unsigned integer dtype. | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When using the deprecated directive, you will need to add blank lines around it