@@ -126,9 +126,10 @@ Here's a typical workflow for triaging a newly opened issue.
126
126
Investigating regressions
127
127
-------------------------
128
128
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.
132
133
133
134
For example: a user reports that ``pd.Series([1, 1]).sum() `` returns ``3 ``
134
135
in pandas version ``1.5.0 `` while in version ``1.4.0 `` it returned ``2 ``. To begin,
@@ -146,19 +147,21 @@ and then run::
146
147
git bisect bad v1.5.0
147
148
git bisect run bash -c "python setup.py build_ext -j 4; python t.py"
148
149
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::
151
154
152
155
git bisect reset
153
156
python setup.py build_ext -j 4
154
157
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.
157
160
158
161
.. 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
162
165
more examples.
163
166
164
167
.. _maintaining.closing :
0 commit comments