Skip to content

Commit 7dc68c5

Browse files
author
Release Manager
committed
gh-38503: Reviewer guide: Link to Eric Gourgoulhon's test notebook <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes #12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes #12345". --> https://groups.google.com/g/sage-devel/c/vFsNl87zLxo/m/yce6yB_TBwAJ ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [ ] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - #12345: short description why this is a dependency --> <!-- - #34567: ... --> URL: #38503 Reported by: Matthias Köppe Reviewer(s):
2 parents a615ae0 + 08838f0 commit 7dc68c5

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

src/doc/en/developer/review.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ The following should generally be checked while reading and testing the code:
7676
optional doctests related to the functionality. See :ref:`chapter-doctesting`
7777
for more information.
7878

79+
For changes that affect the **user interface**, in particular, upgrades to
80+
IPython and Jupyter component packages, manual testing is crucial because
81+
our automatic tests do not cover the user interface. We recommend to use
82+
a `Jupyter notebook with comprehensive tests of graphics and typesetting
83+
<https://github.com/egourgoulhon/SageMathTest/blob/master/Notebooks/test_display.ipynb>`_,
84+
some of which is Sage-specific.
85+
7986
You are now ready to change the PR's status (see
8087
:ref:`section-github-pr-status`):
8188

0 commit comments

Comments
 (0)