Skip to content

Commit f181914

Browse files
committed
DOC: modified bisect section GH35685
1 parent 0c1df38 commit f181914

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

doc/source/development/maintaining.rst

+13-10
Original file line numberDiff line numberDiff line change
@@ -126,9 +126,10 @@ Here's a typical workflow for triaging a newly opened issue.
126126
Investigating regressions
127127
-------------------------
128128

129-
Regressions are bugs that unintentionally break previously working pandas code.
130-
The common way to investigate regressions is by using `git bisect <https://git-scm.com/docs/git-bisect>`_,
131-
which finds the first commit after the bug appears.
129+
Regressions are bugs that unintentionally break previously working code. The common way
130+
to investigate regressions is by using
131+
`git bisect <https://git-scm.com/docs/git-bisect>`_,
132+
which finds the first commit that introduced the bug.
132133

133134
For example: a user reports that ``pd.Series([1, 1]).sum()`` returns ``3``
134135
in pandas version ``1.5.0`` while in version ``1.4.0`` it returned ``2``. To begin,
@@ -146,19 +147,21 @@ and then run::
146147
git bisect bad v1.5.0
147148
git bisect run bash -c "python setup.py build_ext -j 4; python t.py"
148149

149-
This finds the first commit that changed the behavior. To finish, exit bisect and
150-
rebuilt the latest C extensions with::
150+
This finds the first commit that changed the behavior. The C extensions have to be
151+
rebuilt at every step, so the search can take a while.
152+
153+
Exit bisect and rebuild the current version::
151154

152155
git bisect reset
153156
python setup.py build_ext -j 4
154157

155-
Lastly, report your findings under the corresponding issue and ping the commit author to
156-
get their input.
158+
Report your findings under the corresponding issue and ping the commit author to get
159+
their input.
157160

158161
.. note::
159-
The ``run`` command above will treat commits where ``t.py`` exits with ``0`` as good and other
160-
exits as bad. When raising an error is the desired behavior, wrap the code in an appropriate
161-
``try/except`` statement. See `GH35650 <https://github.com/pandas-dev/pandas/issues/35685>`_ for
162+
In the ``bisect run`` command above, commits are considered good if ``t.py`` exits
163+
with ``0`` and bad otherwise. When raising an exception is the desired behavior,
164+
wrap the code in an appropriate ``try/except`` statement. See :issue:`35685` for
162165
more examples.
163166

164167
.. _maintaining.closing:

0 commit comments

Comments
 (0)