Skip to content

Commit be0d4dc

Browse files
committed
Docstring suggestions by kwankyu
For commits eb1f83b and 5696a97.
1 parent 53aa5f0 commit be0d4dc

4 files changed

Lines changed: 66 additions & 66 deletions

File tree

src/sage/libs/ntl/ntl_mat_ZZ.pyx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@ cdef class ntl_mat_ZZ():
492492
493493
INPUT:
494494
495-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
495+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
496496
- ``delta`` -- reduction parameter (default: 0.99)
497497
- ``BlockSize`` -- see above (default: 10)
498498
- ``prune`` -- see above (default: 0)
@@ -563,7 +563,7 @@ cdef class ntl_mat_ZZ():
563563
564564
INPUT:
565565
566-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
566+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
567567
- ``delta`` -- reduction parameter (default: 0.99)
568568
- ``BlockSize`` -- see above (default: 10)
569569
- ``prune`` -- see above (default: 0)
@@ -634,7 +634,7 @@ cdef class ntl_mat_ZZ():
634634
635635
INPUT:
636636
637-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
637+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
638638
- ``delta`` -- reduction parameter (default: 0.99)
639639
- ``BlockSize`` -- see above (default: 10)
640640
- ``prune`` -- see above (default: 0)
@@ -705,7 +705,7 @@ cdef class ntl_mat_ZZ():
705705
706706
INPUT:
707707
708-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
708+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
709709
- ``delta`` -- reduction parameter (default: 0.99)
710710
- ``BlockSize`` -- see above (default: 10)
711711
- ``prune`` -- see above (default: 0)
@@ -776,7 +776,7 @@ cdef class ntl_mat_ZZ():
776776
777777
INPUT:
778778
779-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
779+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
780780
- ``delta`` -- reduction parameter (default: 0.99)
781781
- ``BlockSize`` -- see above (default: 10)
782782
- ``prune`` -- see above (default: 0)
@@ -847,7 +847,7 @@ cdef class ntl_mat_ZZ():
847847
848848
INPUT:
849849
850-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
850+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
851851
- ``delta`` -- reduction parameter (default: 0.99)
852852
- ``BlockSize`` -- see above (default: 10)
853853
- ``prune`` -- see above (default: 0)
@@ -918,7 +918,7 @@ cdef class ntl_mat_ZZ():
918918
919919
INPUT:
920920
921-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
921+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
922922
- ``delta`` -- reduction parameter (default: 0.99)
923923
- ``BlockSize`` -- see above (default: 10)
924924
- ``prune`` -- see above (default: 0)
@@ -989,7 +989,7 @@ cdef class ntl_mat_ZZ():
989989
990990
INPUT:
991991
992-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
992+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
993993
- ``delta`` -- reduction parameter (default: 0.99)
994994
- ``BlockSize`` -- see above (default: 10)
995995
- ``prune`` -- see above (default: 0)
@@ -1060,7 +1060,7 @@ cdef class ntl_mat_ZZ():
10601060
10611061
INPUT:
10621062
1063-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
1063+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
10641064
- ``delta`` -- reduction parameter (default: 0.99)
10651065
- ``BlockSize`` -- see above (default: 10)
10661066
- ``prune`` -- see above (default: 0)
@@ -1131,7 +1131,7 @@ cdef class ntl_mat_ZZ():
11311131
11321132
INPUT:
11331133
1134-
- ``U`` -- (optional) permutation matrix (see LLL, default: ``None``)
1134+
- ``U`` -- permutation matrix (see LLL, default: ``None``)
11351135
- ``delta`` -- reduction parameter (default: 0.99)
11361136
- ``BlockSize`` -- see above (default: 10)
11371137
- ``prune`` -- see above (default: 0)

src/sage/modular/modform/eisenstein_submodule.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -600,8 +600,8 @@ def cyclotomic_restriction(L, K):
600600
601601
INPUT: element alpha in `L`
602602
OUTPUT: a polynomial `f(x)` in `K[x]` such that `f(\zeta_m) = \alpha`,
603-
where we view alpha as living in `M`. (Note that `\zeta_m`
604-
generates `M`, not `L`.)
603+
where we view alpha as living in `M`. (Note that `\zeta_m` generates
604+
`M`, not `L`.)
605605
606606
EXAMPLES::
607607
@@ -646,7 +646,7 @@ def g(x):
646646

647647

648648
def cyclotomic_restriction_tower(L, K):
649-
"""
649+
r"""
650650
Suppose `L/K` is an extension of cyclotomic fields and `L=Q(\zeta_m)`.
651651
This function computes a map with the following property:
652652

src/sage/quadratic_forms/genera/genus.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3194,7 +3194,7 @@ def mass(self, backend='sage'):
31943194
31953195
INPUT:
31963196
3197-
- ``backend`` -- (default: ``'sage'``) or ``'magma'``
3197+
- ``backend`` -- ``'sage'`` (default) or ``'magma'``
31983198
31993199
OUTPUT: a rational number
32003200

src/sage/quadratic_forms/quadratic_form.py

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -362,9 +362,9 @@ class QuadraticForm(SageObject):
362362
count_congruence_solutions__bad_type_II
363363

364364
# Routines to be called by the user to compute local densities
365-
lazy_import("sage.quadratic_forms.quadratic_form__local_density_interfaces", [
366-
"local_density",
367-
"local_primitive_density"
365+
lazy_import('sage.quadratic_forms.quadratic_form__local_density_interfaces', [
366+
'local_density',
367+
'local_primitive_density'
368368
])
369369

370370
# Routines for computing with ternary forms
@@ -401,8 +401,8 @@ class QuadraticForm(SageObject):
401401
theta_by_cholesky
402402

403403
# Routines to compute the product of all local densities
404-
lazy_import("sage.quadratic_forms.quadratic_form__siegel_product", [
405-
"siegel_product"
404+
lazy_import('sage.quadratic_forms.quadratic_form__siegel_product', [
405+
'siegel_product'
406406
])
407407

408408
# Routines to compute p-neighbors
@@ -421,50 +421,50 @@ class QuadraticForm(SageObject):
421421
minkowski_reduction, \
422422
minkowski_reduction_for_4vars__SP
423423
# Wrappers for Conway-Sloane genus routines (in ./genera/)
424-
lazy_import("sage.quadratic_forms.quadratic_form__genus", [
425-
"global_genus_symbol",
426-
"local_genus_symbol",
427-
"CS_genus_symbol_list"
424+
lazy_import('sage.quadratic_forms.quadratic_form__genus', [
425+
'global_genus_symbol',
426+
'local_genus_symbol',
427+
'CS_genus_symbol_list'
428428
])
429429

430430
# Routines to compute local masses for ZZ.
431-
lazy_import("sage.quadratic_forms.quadratic_form__mass", [
432-
"shimura_mass__maximal",
433-
"GHY_mass__maximal"
431+
lazy_import('sage.quadratic_forms.quadratic_form__mass', [
432+
'shimura_mass__maximal',
433+
'GHY_mass__maximal'
434434
])
435-
lazy_import("sage.quadratic_forms.quadratic_form__mass__Siegel_densities", [
436-
"mass__by_Siegel_densities",
437-
"Pall_mass_density_at_odd_prime",
438-
"Watson_mass_at_2",
439-
"Kitaoka_mass_at_2",
440-
"mass_at_two_by_counting_mod_power"
435+
lazy_import('sage.quadratic_forms.quadratic_form__mass__Siegel_densities', [
436+
'mass__by_Siegel_densities',
437+
'Pall_mass_density_at_odd_prime',
438+
'Watson_mass_at_2',
439+
'Kitaoka_mass_at_2',
440+
'mass_at_two_by_counting_mod_power'
441441
])
442-
lazy_import("sage.quadratic_forms.quadratic_form__mass__Conway_Sloane_masses", [
443-
"parity",
444-
"is_even",
445-
"is_odd",
446-
"conway_species_list_at_odd_prime",
447-
"conway_species_list_at_2",
448-
"conway_octane_of_this_unimodular_Jordan_block_at_2",
449-
"conway_diagonal_factor",
450-
"conway_cross_product_doubled_power",
451-
"conway_type_factor",
452-
"conway_p_mass",
453-
"conway_standard_p_mass",
454-
"conway_standard_mass",
455-
"conway_mass"
442+
lazy_import('sage.quadratic_forms.quadratic_form__mass__Conway_Sloane_masses', [
443+
'parity',
444+
'is_even',
445+
'is_odd',
446+
'conway_species_list_at_odd_prime',
447+
'conway_species_list_at_2',
448+
'conway_octane_of_this_unimodular_Jordan_block_at_2',
449+
'conway_diagonal_factor',
450+
'conway_cross_product_doubled_power',
451+
'conway_type_factor',
452+
'conway_p_mass',
453+
'conway_standard_p_mass',
454+
'conway_standard_mass',
455+
'conway_mass'
456456
# conway_generic_mass, \
457457
# conway_p_mass_adjustment
458458
])
459459

460460
# Routines to check local representability of numbers
461-
lazy_import("sage.quadratic_forms.quadratic_form__local_representation_conditions", [
462-
"local_representation_conditions",
463-
"is_locally_universal_at_prime",
464-
"is_locally_universal_at_all_primes",
465-
"is_locally_universal_at_all_places",
466-
"is_locally_represented_number_at_place",
467-
"is_locally_represented_number"
461+
lazy_import('sage.quadratic_forms.quadratic_form__local_representation_conditions', [
462+
'local_representation_conditions',
463+
'is_locally_universal_at_prime',
464+
'is_locally_universal_at_all_primes',
465+
'is_locally_universal_at_all_places',
466+
'is_locally_represented_number_at_place',
467+
'is_locally_represented_number'
468468
])
469469

470470
# Routines to make a split local covering of the given quadratic form.
@@ -475,15 +475,15 @@ class QuadraticForm(SageObject):
475475
split_local_cover
476476

477477
# Routines to make automorphisms of the given quadratic form.
478-
lazy_import("sage.quadratic_forms.quadratic_form__automorphisms", [
479-
"basis_of_short_vectors",
480-
"short_vector_list_up_to_length",
481-
"short_primitive_vector_list_up_to_length",
482-
"_compute_automorphisms",
483-
"automorphism_group",
484-
"automorphisms",
485-
"number_of_automorphisms",
486-
"set_number_of_automorphisms"
478+
lazy_import('sage.quadratic_forms.quadratic_form__automorphisms', [
479+
'basis_of_short_vectors',
480+
'short_vector_list_up_to_length',
481+
'short_primitive_vector_list_up_to_length',
482+
'_compute_automorphisms',
483+
'automorphism_group',
484+
'automorphisms',
485+
'number_of_automorphisms',
486+
'set_number_of_automorphisms'
487487
])
488488

489489
# Routines to test the local and global equivalence/isometry of two quadratic forms.
@@ -494,13 +494,13 @@ class QuadraticForm(SageObject):
494494
is_rationally_isometric
495495

496496
# Routines for solving equations of the form Q(x) = c.
497-
lazy_import("sage.quadratic_forms.qfsolve", [
498-
"solve"
497+
lazy_import('sage.quadratic_forms.qfsolve', [
498+
'solve'
499499
])
500500

501501
# Genus
502-
lazy_import("sage.quadratic_forms.genera.genus",
503-
"_genera_staticmethod", as_='genera')
502+
lazy_import('sage.quadratic_forms.genera.genus',
503+
'_genera_staticmethod', as_='genera')
504504

505505
def __init__(self, R, n=None, entries=None, unsafe_initialization=False, number_of_automorphisms=None, determinant=None):
506506
"""

0 commit comments

Comments
 (0)