sage.modules.fg_pid.fgp_module: Rename a test_... function to _test_... (with deprecation)

[mkoeppe]

(split out from #33549, similar to #33612)

In this way we suppress generating the documentation of this undocumented function. https://doc.sagemath.org/html/en/reference/modules/sage/modules/fg_pid/fgp_module.html#sage.modules.fg_pid.fgp_module.test_morphism_0

While at it, we improve the markup of the documentation.

CC: @tscrim @tobiasdiez @simonbrandhorst @jhpalmieri

Component: documentation

Author: Tobias Diez, Matthias Koeppe

Branch/Commit: 66594c2

Reviewer: John Palmieri

Issue created by migration from https://trac.sagemath.org/ticket/33617

[mkoeppe]

Branch: u/mkoeppe/sage_modules_fg_pid_fgp_module__rename_a_test_____function_to__test______with_deprecation_

[mkoeppe]

Description changed:

--- 
+++ 
@@ -2,3 +2,5 @@
 
 In this way we suppress generating the documentation of this undocumented function. https://doc.sagemath.org/html/en/reference/modules/sage/modules/fg_pid/fgp_module.html#sage.modules.fg_pid.fgp_module.test_morphism_0
 
+While at it, we improve the markup of the documentation.
+

[mkoeppe]

Commit: 66594c2

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

New commits:

6e70cb2	Make test methods private
a0e04eb	src/sage/modules/fg_pid/fgp_module.py: Add deprecated_function_alias test_morphism_0
66594c2	src/sage/modules/fg_pid/fgp_module.py: Fix doc markup

[tscrim]

comment:4

For this one, I think we should move this to a method of the corresponding morphism class so we can test it on instances by TestSuite(phi).run(). Thus, the doctest would become

-sage: set_random_seed(s); v = [fgp.test_morphism_0(1) for _ in range(30)]
+sage: set_random_seed(s)
+sage: for _ in range(30):
+....:     phi = random_fgp_morphism_m(1)
+....:     phi.test_morphism_0()

This would also mean a bit other internal changes to the method, but then it can be applied more broadly. It would also be good to have a better name for this test too. Maybe _test_consistency()?

[mkoeppe]

Changed author from Matthias Koeppe to Tobias Diez, Matthias Koeppe

[jhpalmieri]

comment:8

Looks okay to me, but what about tscrim's comment:4?

[mkoeppe]

comment:9

No idea what these tests do, which is why I cc'ed original authors...

[jhpalmieri]

Reviewer: John Palmieri

[jhpalmieri]

comment:10

I think we should merge this now and do the restructuring later.

[mkoeppe]

comment:11

Thanks!

[vbraun]

Changed branch from u/mkoeppe/sage_modules_fg_pid_fgp_module__rename_a_test_____function_to__test______with_deprecation_ to 66594c2