Skip to content

Conversation

@xcaruso
Copy link
Contributor

@xcaruso xcaruso commented Aug 16, 2025

We fix a couple of issues in the documentation of Drinfeld modules and replace everywhere \mathbb{F} by \GF.

📝 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.
  • I have created tests covering the changes.
  • I have updated the documentation and checked the documentation preview.

⌛ Dependencies

#40430

@user202729
Copy link
Contributor

actually the command should be used as \GF{q}.

@xcaruso
Copy link
Contributor Author

xcaruso commented Aug 16, 2025

Oh sure, sorry!

@github-actions
Copy link

github-actions bot commented Aug 16, 2025

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

@xcaruso xcaruso requested a review from kryzar August 20, 2025 08:22
@kryzar
Copy link
Contributor

kryzar commented Aug 21, 2025

Thanks for the ping.

First failure:

sage -t --warn-long 5.0 --random-seed=198424624499988108757496062634345889454 src/sage/doctest/forker.py  # 1 doctest failed
sage -t --warn-long 5.0 --random-seed=198424624499988108757496062634345889454 src/sage/rings/complex_arb.pyx  # 1 doctest failed
sage -t --warn-long 5.0 --random-seed=198424624499988108757496062634345889454 src/sage/rings/polynomial/plural.pyx  # SignalError in doctesting framework

Second one:

sage -t --warn-long 5.0 --random-seed=42030746900523727760028242117307027756 src/sage/doctest/util.py  # 4 doctests failed

Doc build: I manually went through all instances of rinfeld and Fail and there doesn't seem to be a problem related to our work. If anybody has a better method to check for actual bugs, feel free to jump in.

@user202729
Copy link
Contributor

normally I'd want to check the documentation changes by looking at the generated HTML, but because of the dependencies, there are a lot of false positives. Combined with the fact that the HTML is slow to load and the PDF build is currently broken, I was thinking of looking at the HTML diff after the dependency is merged.

(the problem is incorrect rendering, not build failure.)

@user202729
Copy link
Contributor

other example of incorrect formatting:

image

they're supposed to be a note block, not a raw code block.

the doc build won't warn you, you'd only notice that after looking at the HTML. (that said, I think this is existing issue rather than introduced by this PR, so is not an issue with this PR.)

@user202729
Copy link
Contributor

two more bugs I found (although not introduced by this PR). I'd positive review afterwards.

diff --git a/src/sage/rings/function_field/drinfeld_modules/action.py b/src/sage/rings/function_field/drinfeld_modules/action.py
index 4962162424e..35408b09326 100644
--- a/src/sage/rings/function_field/drinfeld_modules/action.py
+++ b/src/sage/rings/function_field/drinfeld_modules/action.py
@@ -42,12 +42,12 @@ class DrinfeldModuleAction(Action):
     .. NOTE::
 
         The user should never explicitly instantiate the class
-        `DrinfeldModuleAction`.
+        :class:`DrinfeldModuleAction`.
 
     .. WARNING::
 
-        This class may be replaced later on. See issues #34833 and
-        #34834.
+        This class may be replaced later on. See :issue:`34833` and
+        :issue:`34834`.
 
     INPUT: the Drinfeld module
 
diff --git a/src/sage/rings/function_field/drinfeld_modules/charzero_drinfeld_module.py b/src/sage/rings/function_field/drinfeld_modules/charzero_drinfeld_module.py
index 594f8645ae1..02d0e998bde 100644
--- a/src/sage/rings/function_field/drinfeld_modules/charzero_drinfeld_module.py
+++ b/src/sage/rings/function_field/drinfeld_modules/charzero_drinfeld_module.py
@@ -486,7 +486,7 @@ class DrinfeldModule_rational(DrinfeldModule_charzero):
             sage: phi.coefficient_in_function_ring(2)
             T^2
 
-        Compare with the method meth:`coefficient`::
+        Compare with the method :meth:`coefficient`::
 
             sage: phi.coefficient(2)
             U^2

@kryzar
Copy link
Contributor

kryzar commented Aug 22, 2025

Thanks very much for the fixes!

@vbraun vbraun merged commit 17491c7 into sagemath:develop Aug 27, 2025
23 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants