Skip to content

Commit 67d529a

Browse files
committed
DOC: doc warnings
Author: Jeff Reback <[email protected]> Closes #15647 from jreback/doc and squashes the following commits: 6afb394 [Jeff Reback] gbq install adjustment 0fd4499 [Jeff Reback] maybe d5ec228 [Jeff Reback] DOC: fixup some doc-links b7ea898 [Jeff Reback] DOC: some deprecation warnings removed
1 parent 94c6c0c commit 67d529a

File tree

9 files changed

+14
-15
lines changed

9 files changed

+14
-15
lines changed

doc/source/index.rst.template

-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,6 @@ See the package overview for more detail about what's in the library.
116116
whatsnew
117117
install
118118
contributing
119-
faq
120119
overview
121120
10min
122121
tutorials

doc/source/install.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ Optional Dependencies
260260
<http://www.vergenet.net/~conrad/software/xsel/>`__, or `xclip
261261
<https://github.com/astrand/xclip/>`__: necessary to use
262262
:func:`~pandas.read_clipboard`. Most package managers on Linux distributions will have ``xclip`` and/or ``xsel`` immediately available for installation.
263-
* For Google BigQuery I/O - see :ref:`here <io.bigquery_deps>`.
263+
* For Google BigQuery I/O - see `here <https://pandas-gbq.readthedocs.io/en/latest/install.html#dependencies>`__
264264

265265
* `Backports.lzma <https://pypi.python.org/pypi/backports.lzma/>`__: Only for Python 2, for writing to and/or reading from an xz compressed DataFrame in CSV; Python 3 support is built into the standard library.
266266
* One of the following combinations of libraries is needed to use the

doc/source/whatsnew/v0.10.0.txt

+2-3
Original file line numberDiff line numberDiff line change
@@ -303,11 +303,10 @@ Updated PyTables Support
303303
store.append('wp',wp)
304304

305305
# selecting via A QUERY
306-
store.select('wp',
307-
[ Term('major_axis>20000102'), Term('minor_axis', '=', ['A','B']) ])
306+
store.select('wp', "major_axis>20000102 and minor_axis=['A','B']")
308307

309308
# removing data from tables
310-
store.remove('wp', Term('major_axis>20000103'))
309+
store.remove('wp', "major_axis>20000103")
311310
store.select('wp')
312311

313312
# deleting a store

doc/source/whatsnew/v0.10.1.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ perform queries on a table, by passing a list to ``data_columns``
5858

5959
# on-disk operations
6060
store.append('df', df, data_columns = ['B','C','string','string2'])
61-
store.select('df',[ 'B > 0', 'string == foo' ])
61+
store.select('df', "B>0 and string=='foo'")
6262

6363
# this is in-memory version of this type of selection
6464
df[(df.B > 0) & (df.string == 'foo')]
@@ -110,7 +110,7 @@ columns, this is equivalent to passing a
110110
store.select('mi')
111111

112112
# the levels are automatically included as data columns
113-
store.select('mi', Term('foo=bar'))
113+
store.select('mi', "foo='bar'")
114114

115115
Multi-table creation via ``append_to_multiple`` and selection via
116116
``select_as_multiple`` can create/select from multiple tables and return a

doc/source/whatsnew/v0.17.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ has been changed to make this keyword unnecessary - the change is shown below.
329329
Google BigQuery Enhancements
330330
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
331331
- Added ability to automatically create a table/dataset using the :func:`pandas.io.gbq.to_gbq` function if the destination table/dataset does not exist. (:issue:`8325`, :issue:`11121`).
332-
- Added ability to replace an existing table and schema when calling the :func:`pandas.io.gbq.to_gbq` function via the ``if_exists`` argument. See the :ref:`docs <io.bigquery_writer>` for more details (:issue:`8325`).
332+
- Added ability to replace an existing table and schema when calling the :func:`pandas.io.gbq.to_gbq` function via the ``if_exists`` argument. See the `docs <https://pandas-gbq.readthedocs.io/en/latest/writing.html>`__ for more details (:issue:`8325`).
333333
- ``InvalidColumnOrder`` and ``InvalidPageToken`` in the gbq module will raise ``ValueError`` instead of ``IOError``.
334334
- The ``generate_bq_schema()`` function is now deprecated and will be removed in a future version (:issue:`11121`)
335335
- The gbq module will now support Python 3 (:issue:`11094`).

doc/source/whatsnew/v0.18.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ Other enhancements
518518
- Added ``DataFrame.style.format`` for more flexible formatting of cell values (:issue:`11692`)
519519
- ``DataFrame.select_dtypes`` now allows the ``np.float16`` typecode (:issue:`11990`)
520520
- ``pivot_table()`` now accepts most iterables for the ``values`` parameter (:issue:`12017`)
521-
- Added Google ``BigQuery`` service account authentication support, which enables authentication on remote servers. (:issue:`11881`, :issue:`12572`). For further details see :ref:`here <io.bigquery_authentication>`
521+
- Added Google ``BigQuery`` service account authentication support, which enables authentication on remote servers. (:issue:`11881`, :issue:`12572`). For further details see `here <https://pandas-gbq.readthedocs.io/en/latest/intro.html>`__
522522
- ``HDFStore`` is now iterable: ``for k in store`` is equivalent to ``for k in store.keys()`` (:issue:`12221`).
523523
- Add missing methods/fields to ``.dt`` for ``Period`` (:issue:`8848`)
524524
- The entire codebase has been ``PEP``-ified (:issue:`12096`)

doc/source/whatsnew/v0.19.0.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ For ``MultiIndex``, values are dropped if any level is missing by default. Speci
377377
Google BigQuery Enhancements
378378
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
379379

380-
- The :func:`read_gbq` method has gained the ``dialect`` argument to allow users to specify whether to use BigQuery's legacy SQL or BigQuery's standard SQL. See the :ref:`docs <io.bigquery_reader>` for more details (:issue:`13615`).
380+
- The :func:`read_gbq` method has gained the ``dialect`` argument to allow users to specify whether to use BigQuery's legacy SQL or BigQuery's standard SQL. See the `docs <https://pandas-gbq.readthedocs.io/en/latest/reading.html>`__ for more details (:issue:`13615`).
381381
- The :func:`~DataFrame.to_gbq` method now allows the DataFrame column order to differ from the destination table schema (:issue:`11359`).
382382

383383
.. _whatsnew_0190.errstate:

doc/source/whatsnew/v0.20.0.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ New Behavior:
203203

204204
df[df.chromosomes != '1'].groupby('chromosomes', sort=False).sum()
205205

206-
.. _whatsnew_0200.enhancements.table_schema
206+
.. _whatsnew_0200.enhancements.table_schema:
207207

208208
Table Schema Output
209209
^^^^^^^^^^^^^^^^^^^
@@ -337,7 +337,7 @@ Using ``.iloc``. Here we will get the location of the 'A' column, then use *posi
337337
df.iloc[[0, 2], df.columns.get_loc('A')]
338338

339339

340-
.. _whatsnew.api_breaking.io_compat
340+
.. _whatsnew.api_breaking.io_compat:
341341

342342
Possible incompat for HDF5 formats for pandas < 0.13.0
343343
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -758,7 +758,7 @@ Bug Fixes
758758

759759
- Bug in the display of ``.info()`` where a qualifier (+) would always be displayed with a ``MultiIndex`` that contains only non-strings (:issue:`15245`)
760760

761-
- Bug in ``.asfreq()``, where frequency was not set for empty ``Series` (:issue:`14320`)
761+
- Bug in ``.asfreq()``, where frequency was not set for empty ``Series`` (:issue:`14320`)
762762

763763
- Bug in ``pd.read_msgpack()`` in which ``Series`` categoricals were being improperly processed (:issue:`14901`)
764764
- Bug in ``Series.ffill()`` with mixed dtypes containing tz-aware datetimes. (:issue:`14956`)

pandas/io/gbq.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@ def _try_import():
1414
"the pandas-gbq package is not installed\n"
1515
"see the docs: https://pandas-gbq.readthedocs.io\n"
1616
"\n"
17-
"you can install via:\n"
18-
"pip install pandas-gbq\n")
17+
"you can install via pip or conda:\n"
18+
"pip install pandas-gbq\n"
19+
"conda install pandas-gbq -c conda-forge\n")
1920

2021
return pandas_gbq
2122

0 commit comments

Comments
 (0)