Skip to content

Commit 5406926

Browse files
committed
Make consistent use of acronyms, and US spellings for serializ*
1 parent c992e3f commit 5406926

File tree

4 files changed

+26
-26
lines changed

4 files changed

+26
-26
lines changed

doc/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ last committed version can always be restored from git.
140140

141141
::
142142

143-
#omit autosummary and api section
143+
#omit autosummary and API section
144144
python make.py clean
145145
python make.py --no-api
146146

doc/source/gotchas.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,7 +500,7 @@ parse HTML tables in the top-level pandas io function ``read_html``.
500500
molasses. However consider the fact that many tables on the web are not
501501
big enough for the parsing algorithm runtime to matter. It is more
502502
likely that the bottleneck will be in the process of reading the raw
503-
text from the url over the web, i.e., IO (input-output). For very large
503+
text from the URL over the web, i.e., IO (input-output). For very large
504504
tables, this might not be true.
505505

506506
**Issues with using** |Anaconda|_

doc/source/io.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
IO Tools (Text, CSV, HDF5, ...)
3030
*******************************
3131

32-
The pandas I/O api is a set of top level ``reader`` functions accessed like ``pd.read_csv()`` that generally return a ``pandas``
32+
The pandas I/O API is a set of top level ``reader`` functions accessed like ``pd.read_csv()`` that generally return a ``pandas``
3333
object.
3434

3535
* :ref:`read_csv<io.read_csv_table>`
@@ -78,8 +78,8 @@ for some advanced strategies
7878

7979
They can take a number of arguments:
8080

81-
- ``filepath_or_buffer``: Either a string path to a file, url
82-
(including http, ftp, and s3 locations), or any object with a ``read``
81+
- ``filepath_or_buffer``: Either a string path to a file, URL
82+
(including http, ftp, and S3 locations), or any object with a ``read``
8383
method (such as an open file or ``StringIO``).
8484
- ``sep`` or ``delimiter``: A delimiter / separator to split fields
8585
on. `read_csv` is capable of inferring the delimiter automatically in some
@@ -1100,7 +1100,7 @@ function takes a number of arguments. Only the first is required.
11001100
used. (A sequence should be given if the DataFrame uses MultiIndex).
11011101
- ``mode`` : Python write mode, default 'w'
11021102
- ``encoding``: a string representing the encoding to use if the contents are
1103-
non-ascii, for python versions prior to 3
1103+
non-ASCII, for python versions prior to 3
11041104
- ``line_terminator``: Character sequence denoting line end (default '\\n')
11051105
- ``quoting``: Set quoting rules as in csv module (default csv.QUOTE_MINIMAL)
11061106
- ``quotechar``: Character used to quote fields (default '"')
@@ -1184,7 +1184,7 @@ with optional parameters:
11841184
- ``double_precision`` : The number of decimal places to use when encoding floating point values, default 10.
11851185
- ``force_ascii`` : force encoded string to be ASCII, default True.
11861186
- ``date_unit`` : The time unit to encode to, governs timestamp and ISO8601 precision. One of 's', 'ms', 'us' or 'ns' for seconds, milliseconds, microseconds and nanoseconds respectively. Default 'ms'.
1187-
- ``default_handler`` : The handler to call if an object cannot otherwise be converted to a suitable format for JSON. Takes a single argument, which is the object to convert, and returns a serialisable object.
1187+
- ``default_handler`` : The handler to call if an object cannot otherwise be converted to a suitable format for JSON. Takes a single argument, which is the object to convert, and returns a serializable object.
11881188

11891189
Note ``NaN``'s, ``NaT``'s and ``None`` will be converted to ``null`` and ``datetime`` objects will be converted based on the ``date_format`` and ``date_unit`` parameters.
11901190

@@ -1208,7 +1208,7 @@ file / string. Consider the following DataFrame and Series:
12081208
sjo = Series(dict(x=15, y=16, z=17), name='D')
12091209
sjo
12101210
1211-
**Column oriented** (the default for ``DataFrame``) serialises the data as
1211+
**Column oriented** (the default for ``DataFrame``) serializes the data as
12121212
nested JSON objects with column labels acting as the primary index:
12131213

12141214
.. ipython:: python
@@ -1224,7 +1224,7 @@ but the index labels are now primary:
12241224
dfjo.to_json(orient="index")
12251225
sjo.to_json(orient="index")
12261226
1227-
**Record oriented** serialises the data to a JSON array of column -> value records,
1227+
**Record oriented** serializes the data to a JSON array of column -> value records,
12281228
index labels are not included. This is useful for passing DataFrame data to plotting
12291229
libraries, for example the JavaScript library d3.js:
12301230

@@ -1233,15 +1233,15 @@ libraries, for example the JavaScript library d3.js:
12331233
dfjo.to_json(orient="records")
12341234
sjo.to_json(orient="records")
12351235
1236-
**Value oriented** is a bare-bones option which serialises to nested JSON arrays of
1236+
**Value oriented** is a bare-bones option which serializes to nested JSON arrays of
12371237
values only, column and index labels are not included:
12381238

12391239
.. ipython:: python
12401240
12411241
dfjo.to_json(orient="values")
12421242
# Not available for Series
12431243
1244-
**Split oriented** serialises to a JSON object containing separate entries for
1244+
**Split oriented** serializes to a JSON object containing separate entries for
12451245
values, index and columns. Name is also included for ``Series``:
12461246

12471247
.. ipython:: python
@@ -1252,13 +1252,13 @@ values, index and columns. Name is also included for ``Series``:
12521252
.. note::
12531253

12541254
Any orient option that encodes to a JSON object will not preserve the ordering of
1255-
index and column labels during round-trip serialisation. If you wish to preserve
1255+
index and column labels during round-trip serialization. If you wish to preserve
12561256
label ordering use the `split` option as it uses ordered containers.
12571257

12581258
Date Handling
12591259
+++++++++++++
12601260

1261-
Writing in iso date format
1261+
Writing in ISO date format
12621262

12631263
.. ipython:: python
12641264
@@ -1268,7 +1268,7 @@ Writing in iso date format
12681268
json = dfd.to_json(date_format='iso')
12691269
json
12701270
1271-
Writing in iso date format, with microseconds
1271+
Writing in ISO date format, with microseconds
12721272

12731273
.. ipython:: python
12741274
@@ -1297,17 +1297,17 @@ Writing to a file, with a date index and a date column
12971297
Fallback Behavior
12981298
+++++++++++++++++
12991299

1300-
If the JSON serialiser cannot handle the container contents directly it will fallback in the following manner:
1300+
If the JSON serializer cannot handle the container contents directly it will fallback in the following manner:
13011301

13021302
- if a ``toDict`` method is defined by the unrecognised object then that
1303-
will be called and its returned ``dict`` will be JSON serialised.
1303+
will be called and its returned ``dict`` will be JSON serialized.
13041304
- if a ``default_handler`` has been passed to ``to_json`` that will
13051305
be called to convert the object.
13061306
- otherwise an attempt is made to convert the object to a ``dict`` by
13071307
parsing its contents. However if the object is complex this will often fail
13081308
with an ``OverflowError``.
13091309

1310-
Your best bet when encountering ``OverflowError`` during serialisation
1310+
Your best bet when encountering ``OverflowError`` during serialization
13111311
is to specify a ``default_handler``. For example ``timedelta`` can cause
13121312
problems:
13131313

@@ -1349,7 +1349,7 @@ The parser will try to parse a ``DataFrame`` if ``typ`` is not supplied or
13491349
is ``None``. To explicitly force ``Series`` parsing, pass ``typ=series``
13501350

13511351
- ``filepath_or_buffer`` : a **VALID** JSON string or file handle / StringIO. The string could be
1352-
a URL. Valid URL schemes include http, ftp, s3, and file. For file URLs, a host
1352+
a URL. Valid URL schemes include http, ftp, S3, and file. For file URLs, a host
13531353
is expected. For instance, a local file could be
13541354
file ://localhost/path/to/table.json
13551355
- ``typ`` : type of object to recover (series or frame), default 'frame'
@@ -1480,7 +1480,7 @@ The Numpy Parameter
14801480
This supports numeric data only. Index and columns labels may be non-numeric, e.g. strings, dates etc.
14811481

14821482
If ``numpy=True`` is passed to ``read_json`` an attempt will be made to sniff
1483-
an appropriate dtype during deserialisation and to subsequently decode directly
1483+
an appropriate dtype during deserialization and to subsequently decode directly
14841484
to numpy arrays, bypassing the need for intermediate Python objects.
14851485

14861486
This can provide speedups if you are deserialising a large amount of numeric
@@ -1586,7 +1586,7 @@ Reading HTML Content
15861586
.. versionadded:: 0.12.0
15871587

15881588
The top-level :func:`~pandas.io.html.read_html` function can accept an HTML
1589-
string/file/url and will parse HTML tables into list of pandas DataFrames.
1589+
string/file/URL and will parse HTML tables into list of pandas DataFrames.
15901590
Let's look at a few examples.
15911591

15921592
.. note::

doc/source/release.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ Bug Fixes
329329
- Bug in groupby dtype conversion with datetimelike (:issue:`5869`)
330330
- Regression in handling of empty Series as indexers to Series (:issue:`5877`)
331331
- Bug in internal caching, related to (:issue:`5727`)
332-
- Testing bug in reading json/msgpack from a non-filepath on windows under py3 (:issue:`5874`)
332+
- Testing bug in reading JSON/msgpack from a non-filepath on windows under py3 (:issue:`5874`)
333333
- Bug when assigning to .ix[tuple(...)] (:issue:`5896`)
334334
- Bug in fully reindexing a Panel (:issue:`5905`)
335335
- Bug in idxmin/max with object dtypes (:issue:`5914`)
@@ -649,7 +649,7 @@ API Changes
649649
Options are seconds, milliseconds, microseconds and nanoseconds.
650650
(:issue:`4362`, :issue:`4498`).
651651
- added ``default_handler`` parameter to allow a callable to be passed
652-
which will be responsible for handling otherwise unserialisable objects.
652+
which will be responsible for handling otherwise unserialiable objects.
653653
(:issue:`5138`)
654654

655655
- ``Index`` and ``MultiIndex`` changes (:issue:`4039`):
@@ -802,7 +802,7 @@ See :ref:`Internal Refactoring<whatsnew_0130.refactoring>`
802802

803803
- ``swapaxes`` on a ``Panel`` with the same axes specified now return a copy
804804
- support attribute access for setting
805-
- ``filter`` supports same api as original ``DataFrame`` filter
805+
- ``filter`` supports same API as original ``DataFrame`` filter
806806
- ``fillna`` refactored to ``core/generic.py``, while > 3ndim is
807807
``NotImplemented``
808808

@@ -927,7 +927,7 @@ Bug Fixes
927927
as the docstring says (:issue:`4362`).
928928
- ``as_index`` is no longer ignored when doing groupby apply (:issue:`4648`,
929929
:issue:`3417`)
930-
- JSON NaT handling fixed, NaTs are now serialised to `null` (:issue:`4498`)
930+
- JSON NaT handling fixed, NaTs are now serialized to `null` (:issue:`4498`)
931931
- Fixed JSON handling of escapable characters in JSON object keys
932932
(:issue:`4593`)
933933
- Fixed passing ``keep_default_na=False`` when ``na_values=None``
@@ -1760,7 +1760,7 @@ Bug Fixes
17601760
- Fixed a bug in the legend of plotting.andrews_curves() (:issue:`3278`)
17611761
- Produce a series on apply if we only generate a singular series and have
17621762
a simple index (:issue:`2893`)
1763-
- Fix Python ascii file parsing when integer falls outside of floating point
1763+
- Fix Python ASCII file parsing when integer falls outside of floating point
17641764
spacing (:issue:`3258`)
17651765
- fixed pretty priniting of sets (:issue:`3294`)
17661766
- Panel() and Panel.from_dict() now respects ordering when give OrderedDict (:issue:`3303`)
@@ -2783,7 +2783,7 @@ Bug Fixes
27832783
(:issue:`1013`)
27842784
- DataFrame.plot(logy=True) has no effect (:issue:`1011`).
27852785
- Broken arithmetic operations between SparsePanel-Panel (:issue:`1015`)
2786-
- Unicode repr issues in MultiIndex with non-ascii characters (:issue:`1010`)
2786+
- Unicode repr issues in MultiIndex with non-ASCII characters (:issue:`1010`)
27872787
- DataFrame.lookup() returns inconsistent results if exact match not present
27882788
(:issue:`1001`)
27892789
- DataFrame arithmetic operations not treating None as NA (:issue:`992`)

0 commit comments

Comments
 (0)