Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

src/doc: Update # needs #36679

Merged
merged 10 commits into from
Dec 10, 2023
Merged

src/doc: Update # needs #36679

merged 10 commits into from
Dec 10, 2023

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Nov 8, 2023

Also some doctest cosmetics.

In part cherry-picked from #35095.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

@kwankyu
Copy link
Collaborator

kwankyu commented Nov 9, 2023

Otherwise, looks good to me.

sage: # needs sage.rings.number_field
sage: sqrt_2 = AA(2)^(1/2)
sage: cbrt_2 = AA(2)^(1/3)
sage: timeit('Polyhedron(vertices=[[sqrt_2, 0], [0, cbrt_2]])')
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You must put back the tag # random. The CI reports a doctest error:

sage -t --long --random-seed=286735480429121101562228604801325644303 doc/en/thematic_tutorials/geometry/polyhedra_tutorial.rst
**********************************************************************
File "doc/en/thematic_tutorials/geometry/polyhedra_tutorial.rst", line 205, in doc.en.thematic_tutorials.geometry.polyhedra_tutorial
Failed example:
    timeit('Polyhedron(vertices=[[sqrt_2, 0], [0, cbrt_2]])')
Expected:
    5 loops, best of 3: 43.2 ms per loop
Got:
    25 loops, best of 3: 21.9 ms per loop
**********************************************************************
1 item had failures:
   1 of 100 in doc.en.thematic_tutorials.geometry.polyhedra_tutorial
    [99 tests, 1 failure, 16.62 s]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this, fixed in f43552e

Copy link

github-actions bot commented Nov 9, 2023

Documentation preview for this PR (built with commit f43552e; changes) is ready! 🎉

Copy link
Contributor

@dcoudert dcoudert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Nov 9, 2023

Thanks both!

vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 7, 2023
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

Also some doctest cosmetics.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
In part cherry-picked from sagemath#35095.
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [ ] 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 accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36679
Reported by: Matthias Köppe
Reviewer(s): David Coudert, Kwankyu Lee, Matthias Köppe
@vbraun vbraun merged commit e204ca8 into sagemath:develop Dec 10, 2023
20 of 21 checks passed
@mkoeppe mkoeppe added this to the sage-10.3 milestone Dec 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants