-
-
Notifications
You must be signed in to change notification settings - Fork 487
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/sage/schemes: Doctest cosmetics #37609
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left a bunch of suggestions and small comments thoughout. Essentially everything you've done improves the docstrings but I noticed some missing changes. I probably missed even more changes as I only reviewed the diff.
@@ -108,15 +108,15 @@ def c4c6_model(c4, c6, assume_nonsingular=False): | |||
|
|||
- ``c4``, ``c6`` -- elements of a number field | |||
|
|||
- ``assume_nonsingular`` (boolean, default False) -- if True, | |||
- ``assume_nonsingular`` (boolean, default ``False``) -- if ``True``, | |||
check for integrality and nosingularity. | |||
|
|||
OUTPUT: | |||
|
|||
The elliptic curve with a-invariants [0,0,0,-c4/48,-c6/864], whose | |||
c-invariants are the given c4, c6. If the supplied invariants are |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General comment, should we do c_4
for latex, double backticks for code or leave c4 as c4 in plaintest? This applies to many functions in this file.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably formatting as LaTeX would be good here, but I'm not going to do it in this PR.
I'll be happy to review a follow-up PR that makes further improvements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually I found a moment to take care of some of these markup changes in this file. That's 74c43cd
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Three last things I noticed. One should fix the failing linter test.
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
Co-authored-by: Giacomo Pope <44242839+GiacomoPope@users.noreply.github.com>
Thanks for the edits! Good to go now? |
Documentation preview for this PR (built with commit 86143e8; changes) is ready! 🎉 |
Yep! LGTM. Thanks so much to taking the time to clean these things up. |
Thanks! |
Standard reformatting of doctests and their outputs
Split out from #35095
📝 Checklist
⌛ Dependencies