Skip to content

Commit 66dab96

Browse files
committed
Merge remote-tracking branch 'upstream/master' into docstrings_dataframe_describe
* upstream/master: (158 commits) Add link to "Craft Minimal Bug Report" blogpost (pandas-dev#20431) BUG: fixed json_normalize for subrecords with NoneTypes (pandas-dev#20030) (pandas-dev#20399) BUG: ExtensionArray.fillna for scalar values (pandas-dev#20412) DOC" update the Pandas core window rolling count docstring" (pandas-dev#20264) DOC: update the pandas.DataFrame.plot.hist docstring (pandas-dev#20155) DOC: Only use ~ in class links to hide prefixes. (pandas-dev#20402) Bug: Allow np.timedelta64 objects to index TimedeltaIndex (pandas-dev#20408) DOC: add disallowing of Series construction of len-1 list with index to whatsnew (pandas-dev#20392) MAINT: Remove weird pd file DOC: update the Index.isin docstring (pandas-dev#20249) BUG: Handle all-NA blocks in concat (pandas-dev#20382) DOC: update the pandas.core.resample.Resampler.fillna docstring (pandas-dev#20379) BUG: Don't raise exceptions splitting a blank string (pandas-dev#20067) DOC: update the pandas.DataFrame.cummax docstring (pandas-dev#20336) DOC: update the pandas.core.window.x.mean docstring (pandas-dev#20265) DOC: update the api.types.is_number docstring (pandas-dev#20196) Fix linter (pandas-dev#20389) DOC: Improved the docstring of pandas.Series.dt.to_pytimedelta (pandas-dev#20142) DOC: update the pandas.Series.dt.is_month_end docstring (pandas-dev#20181) DOC: update the window.Rolling.min docstring (pandas-dev#20263) ...
2 parents 1277860 + 17c1fad commit 66dab96

File tree

109 files changed

+10012
-3410
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

109 files changed

+10012
-3410
lines changed

.gitignore

+2-1
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ dist
6161
.coverage
6262
coverage.xml
6363
coverage_html_report
64+
*.pytest_cache
6465

6566
# OS generated files #
6667
######################
@@ -90,7 +91,6 @@ scikits
9091

9192
# Unit / Performance Testing #
9293
##############################
93-
.pytest_cache/
9494
asv_bench/env/
9595
asv_bench/html/
9696
asv_bench/results/
@@ -109,3 +109,4 @@ doc/tmp.sv
109109
doc/source/styled.xlsx
110110
doc/source/templates/
111111
env/
112+
doc/source/savefig/

ci/build_docs.sh

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ echo "inside $0"
1010

1111
git show --pretty="format:" --name-only HEAD~5.. --first-parent | grep -P "rst|txt|doc"
1212

13-
if [ "$?" != "0" ]; then
14-
echo "Skipping doc build, none were modified"
15-
# nope, skip docs build
16-
exit 0
17-
fi
13+
# if [ "$?" != "0" ]; then
14+
# echo "Skipping doc build, none were modified"
15+
# # nope, skip docs build
16+
# exit 0
17+
# fi
1818

1919

2020
if [ "$DOC" ]; then

ci/requirements-2.7_COMPAT.pip

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
html5lib==1.0b2
2-
beautifulsoup4==4.2.0
2+
beautifulsoup4==4.2.1
33
openpyxl
44
argparse

ci/requirements-3.6_NUMPY_DEV.build.sh

+1-2
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ PRE_WHEELS="https://7933911d6844c6c53a7d-47bd50c35cd79bd838daf386af554a83.ssl.cf
1212
pip install --pre --upgrade --timeout=60 -f $PRE_WHEELS numpy scipy
1313

1414
# install dateutil from master
15-
# pip install -U git+git://github.com/dateutil/dateutil.git
16-
pip install dateutil
15+
pip install -U git+git://github.com/dateutil/dateutil.git
1716

1817
# cython via pip
1918
pip install cython

ci/requirements-optional-conda.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
beautifulsoup4
1+
beautifulsoup4>=4.2.1
22
blosc
33
bottleneck
44
fastparquet

ci/requirements-optional-pip.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# This file was autogenerated by scripts/convert_deps.py
22
# Do not modify directly
3-
beautifulsoup4
3+
beautifulsoup4>=4.2.1
44
blosc
55
bottleneck
66
fastparquet

doc/cheatsheet/Pandas_Cheat_Sheet.pdf

160 KB
Binary file not shown.
-71.3 KB
Binary file not shown.

doc/source/contributing.rst

+54-46
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ Bug reports and enhancement requests
3232

3333
Bug reports are an important part of making *pandas* more stable. Having a complete bug report
3434
will allow others to reproduce the bug and provide insight into fixing. See
35-
`this stackoverflow article <https://stackoverflow.com/help/mcve>`_ for tips on
36-
writing a good bug report.
35+
`this stackoverflow article <https://stackoverflow.com/help/mcve>`_ and
36+
`this blogpost <http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports>`_
37+
for tips on writing a good bug report.
3738

3839
Trying the bug-producing code out on the *master* branch is often a worthwhile exercise
3940
to confirm the bug still exists. It is also worth searching existing bug reports and pull requests
@@ -246,16 +247,16 @@ changes in this branch specific to one bug or feature so it is clear
246247
what the branch brings to *pandas*. You can have many shiny-new-features
247248
and switch in between them using the git checkout command.
248249

249-
To update this branch, you need to retrieve the changes from the master branch::
250+
When creating this branch, make sure your master branch is up to date with
251+
the latest upstream master version. To update your local master branch, you
252+
can do::
250253

251-
git fetch upstream
252-
git rebase upstream/master
254+
git checkout master
255+
git pull upstream master --ff-only
253256

254-
This will replay your commits on top of the latest pandas git master. If this
255-
leads to merge conflicts, you must resolve these before submitting your pull
256-
request. If you have uncommitted changes, you will need to ``stash`` them prior
257-
to updating. This will effectively store your changes and they can be reapplied
258-
after updating.
257+
When you want to update the feature branch with changes in master after
258+
you created the branch, check the section on
259+
:ref:`updating a PR <contributing.update-pr>`.
259260

260261
.. _contributing.documentation:
261262

@@ -293,12 +294,9 @@ Some other important things to know about the docs:
293294
overviews per topic together with some other information (what's new,
294295
installation, etc).
295296

296-
- The docstrings follow the **Numpy Docstring Standard**, which is used widely
297-
in the Scientific Python community. This standard specifies the format of
298-
the different sections of the docstring. See `this document
299-
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
300-
for a detailed explanation, or look at some of the existing functions to
301-
extend it in a similar manner.
297+
- The docstrings follow a pandas convention, based on the **Numpy Docstring
298+
Standard**. Follow the :ref:`pandas docstring guide <docstring>` for detailed
299+
instructions on how to write a correct docstring.
302300

303301
- The tutorials make heavy use of the `ipython directive
304302
<http://matplotlib.org/sampledoc/ipython_directive.html>`_ sphinx extension.
@@ -967,32 +965,6 @@ Now you can commit your changes in your local repository::
967965
968966
git commit -m
969967
970-
Combining commits
971-
-----------------
972-
973-
If you have multiple commits, you may want to combine them into one commit, often
974-
referred to as "squashing" or "rebasing". This is a common request by package maintainers
975-
when submitting a pull request as it maintains a more compact commit history. To rebase
976-
your commits::
977-
978-
git rebase -i HEAD~#
979-
980-
Where # is the number of commits you want to combine. Then you can pick the relevant
981-
commit message and discard others.
982-
983-
To squash to the master branch do::
984-
985-
git rebase -i master
986-
987-
Use the ``s`` option on a commit to ``squash``, meaning to keep the commit messages,
988-
or ``f`` to ``fixup``, meaning to merge the commit messages.
989-
990-
Then you will need to push the branch (see below) forcefully to replace the current
991-
commits with the new ones::
992-
993-
git push origin shiny-new-feature -f
994-
995-
996968
Pushing your changes
997969
--------------------
998970
@@ -1048,15 +1020,51 @@ release. To submit a pull request:
10481020
#. Click ``Send Pull Request``.
10491021
10501022
This request then goes to the repository maintainers, and they will review
1051-
the code. If you need to make more changes, you can make them in
1052-
your branch, push them to GitHub, and the pull request will be automatically
1053-
updated. Pushing them to GitHub again is done by::
1023+
the code.
1024+
1025+
.. _contributing.update-pr:
10541026
1055-
git push -f origin shiny-new-feature
1027+
Updating your pull request
1028+
--------------------------
1029+
1030+
Based on the review you get on your pull request, you will probably need to make
1031+
some changes to the code. In that case, you can make them in your branch,
1032+
add a new commit to that branch, push it to GitHub, and the pull request will be
1033+
automatically updated. Pushing them to GitHub again is done by::
1034+
1035+
git push origin shiny-new-feature
10561036
10571037
This will automatically update your pull request with the latest code and restart the
10581038
:ref:`Continuous Integration <contributing.ci>` tests.
10591039
1040+
Another reason you might need to update your pull request is to solve conflicts
1041+
with changes that have been merged into the master branch since you opened your
1042+
pull request.
1043+
1044+
To do this, you need to "merge upstream master" in your branch::
1045+
1046+
git checkout shiny-new-feature
1047+
git fetch upstream
1048+
git merge upstream/master
1049+
1050+
If there are no conflicts (or they could be fixed automatically), a file with a
1051+
default commit message will open, and you can simply save and quit this file.
1052+
1053+
If there are merge conflicts, you need to solve those conflicts. See for
1054+
example at https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/
1055+
for an explanation on how to do this.
1056+
Once the conflicts are merged and the files where the conflicts were solved are
1057+
added, you can run ``git commit`` to save those fixes.
1058+
1059+
If you have uncommitted changes at the moment you want to update the branch with
1060+
master, you will need to ``stash`` them prior to updating (see the
1061+
`stash docs <https://git-scm.com/book/en/v2/Git-Tools-Stashing-and-Cleaning>`__).
1062+
This will effectively store your changes and they can be reapplied after updating.
1063+
1064+
After the feature branch has been update locally, you can now update your pull
1065+
request by pushing to the branch on GitHub::
1066+
1067+
git push origin shiny-new-feature
10601068
10611069
Delete your merged branch (optional)
10621070
------------------------------------

0 commit comments

Comments
 (0)