Skip to content

Commit e16cff4

Browse files
committed
add contributing.rst to index.rst
1 parent e31af26 commit e16cff4

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

docs/source/contributing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,21 @@ Bug reports must:
3737

3838
#. Include a short, self-contained Python snippet reproducing the problem.
3939
You can format the code nicely by using `GitHub Flavored Markdown
40-
<http://github.github.com/github-flavored-markdown/>`_::
40+
<http://github.github.com/github-flavored-markdown/>`__
41+
42+
.. code-block:: python
4143
42-
```python
4344
>>> from pandas_gbq import gbq
4445
>>> df = gbq.read_gbq(...)
4546
...
46-
```
4747
48-
#. Include the full version string of *pandas-gbq*. ::
48+
#. Include the full version string of *pandas-gbq*.
49+
50+
.. code-block:: python
4951
50-
```python
5152
>>> import pandas_gbq
5253
>>> pandas_gbq.__version__
5354
...
54-
```
5555
5656
#. Explain why the current behavior is wrong/not desired and what you expect instead.
5757

@@ -282,7 +282,7 @@ directive. This should also be put in the docstring when adding a new function
282282
or method.
283283

284284
Contributing your changes to *pandas-gbq*
285-
=====================================
285+
=========================================
286286

287287
Committing your code
288288
--------------------
@@ -438,4 +438,4 @@ branch has not actually been merged.
438438

439439
The branch will still exist on GitHub, so to delete it there do::
440440

441-
git push origin --delete shiny-new-feature
441+
git push origin --delete shiny-new-feature

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Contents:
3030
writing.rst
3131
tables.rst
3232
api.rst
33+
contributing.rst
3334
changelog.rst
3435

3536

docs/source/reading.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _reader:
22

3-
Reading
4-
=======
3+
Reading Tables
4+
==============
55

66
Suppose you want to load all data from an existing BigQuery table : `test_dataset.test_table`
77
into a DataFrame using the :func:`~read_gbq` function.

docs/source/tables.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _create_tables:
22

3-
Creating BigQuery Tables
4-
========================
3+
Creating Tables
4+
===============
55

66
.. code-block:: ipython
77

0 commit comments

Comments
 (0)