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.

Sign up for GitHub

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

Jump to bottom

Some documentation clean-up #39043

Merged
merged 2 commits into from
Dec 8, 2024
Merged

Some documentation clean-up #39043

merged 2 commits into from
Dec 8, 2024

Conversation

user202729
Copy link
Contributor

@user202729 user202729 commented Nov 27, 2024 •
edited
Loading

Consolidate the description. Previously it was scattered into 3 different places.

also some minor changes (now mwrank_lib is the default as I read from the code)

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion. (not aware of one)
  • I have created tests covering the changes. (no functional change)
  • I have updated the documentation and checked the documentation preview.

@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 27, 2024 •
edited
Loading

Documentation preview for this PR (built with commit f1c6b07; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@user202729 user202729 force-pushed the ell-descent-doc-fix branch 2 times, most recently from 0d99b53 to f40c0f6 Compare November 27, 2024 10:13
tscrim
tscrim requested changes Nov 28, 2024
View reviewed changes
Copy link
Collaborator

@tscrim tscrim left a comment

Choose a reason for hiding this comment

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

I don't agree that this is an improvement. For hidden methods, it is okay, but for public facing ones (i.e., in the reference manual), I think it is better to be more self-contained, even if it means duplication and extra maintenance. (Ideally, there would be a way to have things copied automatically, but that is like trying to avoid the wretch...)

@user202729
Copy link
Contributor Author

Before clicking through it I thought you would link https://xkcd.com/1319/ instead.

Anyway I put back the duplication. The change is not just because previously the same thing was copy pasted to 4 places, the problem is it was inconsistent and unclear.

Content change:

  • I remove the |x|+|z| in explanation of first_limit, hopefully it doesn't cause any change.
  • For some reason the second_limit was previously shown as naive height bound although it was never mentioned in source code of mwrank (https://github.com/JohnCremona/eclib), I edit it to logarithmic height bound.

One of the 4 copies are internal, so I leave it as an indirection. The rest are explicitly documented.

user202729
user202729 commented Nov 28, 2024
View reviewed changes
src/sage/schemes/elliptic_curves/ell_rational_field.py
@@ -2268,7 +2280,11 @@ def gens(self, proof=None, **kwds):
- ``use_database`` -- boolean (default: ``True``); if ``True``, attempts to
find curve and gens in the (optional) database

- ``descent_second_limit`` -- (default: 12) used in 2-descent
- ``descent_second_limit`` -- (default: 12); logarithmic height bound on
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also I notice the default here is 12 instead of 8… changing it would be a functional change though.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would leave it. I don't feel comfortable reviewing such a change.

tscrim
tscrim approved these changes Nov 29, 2024
View reviewed changes
Copy link
Collaborator

@tscrim tscrim left a comment

Choose a reason for hiding this comment

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

LGTM.

cc-ing @JohnCremona in case he has any comments.

@JohnCremona
Copy link
Member

LGTM.

cc-ing @JohnCremona in case he has any comments.

Very good! These changes have my absolute approval, thanks.

vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 6, 2024
sagemathgh-39043: Some documentation clean-up
a105033 
    
Consolidate the description. Previously it was scattered into 3
different places.

also some minor changes (now `mwrank_lib` is the default as I read from
the code)

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion. (not aware of one)
- [x] I have created tests covering the changes. (no functional change)
- [x] I have updated the documentation and checked the documentation
preview.
    
URL: sagemath#39043
Reported by: user202729
Reviewer(s): Travis Scrimshaw, user202729
vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 8, 2024
sagemathgh-39043: Some documentation clean-up
c413bec 
    
Consolidate the description. Previously it was scattered into 3
different places.

also some minor changes (now `mwrank_lib` is the default as I read from
the code)

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion. (not aware of one)
- [x] I have created tests covering the changes. (no functional change)
- [x] I have updated the documentation and checked the documentation
preview.
    
URL: sagemath#39043
Reported by: user202729
Reviewer(s): Travis Scrimshaw, user202729
@vbraun vbraun merged commit 28c162e into sagemath:develop Dec 8, 2024
27 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tscrim tscrim tscrim approved these changes

Assignees
No one assigned
Labels
c: documentation c: elliptic curves c: interfaces
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@user202729 @JohnCremona @tscrim @vbraun