Merge pull request #3 from kwankyu/refactor_function_field

Matthias Köppe · web-flow · commit 63be8bf6cec0 · 2023-03-19T08:49:07.000-07:00
Add missing titles to new files
diff --git a/src/doc/en/reference/function_fields/index.rst b/src/doc/en/reference/function_fields/index.rst
@@ -11,6 +11,8 @@ algebraic closure of `\QQ`.
    :maxdepth: 1
 
    sage/rings/function_field/function_field
+   sage/rings/function_field/function_field_rational
+   sage/rings/function_field/function_field_polymod
    sage/rings/function_field/element
    sage/rings/function_field/element_rational
    sage/rings/function_field/element_polymod
diff --git a/src/sage/rings/function_field/derivations_polymod.py b/src/sage/rings/function_field/derivations_polymod.py
@@ -1,3 +1,7 @@
+r"""
+Derivations of function fields: extension
+"""
+
 # ****************************************************************************
 #       Copyright (C) 2010      William Stein <wstein@gmail.com>
 #                     2011-2017 Julian Rüth <julian.rueth@gmail.com>
diff --git a/src/sage/rings/function_field/derivations_rational.py b/src/sage/rings/function_field/derivations_rational.py
@@ -1,3 +1,7 @@
+r"""
+Derivations of function fields: rational
+"""
+
 # ****************************************************************************
 #       Copyright (C) 2010      William Stein <wstein@gmail.com>
 #                     2011-2017 Julian Rüth <julian.rueth@gmail.com>
diff --git a/src/sage/rings/function_field/element_polymod.pyx b/src/sage/rings/function_field/element_polymod.pyx
@@ -1,4 +1,7 @@
 # sage.doctest: optional - sage.rings.function_field
+r"""
+Elements of function fields: extension
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
diff --git a/src/sage/rings/function_field/element_rational.pyx b/src/sage/rings/function_field/element_rational.pyx
@@ -1,3 +1,6 @@
+r"""
+Elements of function fields: rational
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
diff --git a/src/sage/rings/function_field/function_field_polymod.py b/src/sage/rings/function_field/function_field_polymod.py
@@ -1,4 +1,7 @@
 # sage.doctest: optional - sage.rings.function_field
+r"""
+Function Fields: extension
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
diff --git a/src/sage/rings/function_field/function_field_rational.py b/src/sage/rings/function_field/function_field_rational.py
@@ -1,3 +1,7 @@
+r"""
+Function Fields: rational
+"""
+
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
 #
diff --git a/src/sage/rings/function_field/ideal_polymod.py b/src/sage/rings/function_field/ideal_polymod.py
@@ -1,4 +1,7 @@
 # sage.doctest: optional - sage.rings.function_field
+r"""
+Ideals of function fields: extension
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
diff --git a/src/sage/rings/function_field/ideal_rational.py b/src/sage/rings/function_field/ideal_rational.py
@@ -1,3 +1,7 @@
+r"""
+Ideals of function fields: rational
+"""
+
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
 #
diff --git a/src/sage/rings/function_field/order_basis.py b/src/sage/rings/function_field/order_basis.py
@@ -1,7 +1,7 @@
 # sage.doctest:           optional - sage.modules           (because __init__ constructs a vector space)
 # some tests are marked # optional - sage.rings.finite_rings         (because they use finite fields)
 r"""
-Orders of function fields given by a basis over the maximal order of the base field
+Orders of function fields: basis
 """
 
 #*****************************************************************************
diff --git a/src/sage/rings/function_field/order_polymod.py b/src/sage/rings/function_field/order_polymod.py
@@ -1,7 +1,6 @@
 # sage.doctest: optional - sage.rings.function_field
-
 r"""
-Orders of function fields - polymod implementation
+Orders of function fields: extension
 """
 
 #*****************************************************************************
diff --git a/src/sage/rings/function_field/order_rational.py b/src/sage/rings/function_field/order_rational.py
@@ -1,5 +1,5 @@
 r"""
-Orders of rational function fields
+Orders of function fields: rational
 """
 
 #*****************************************************************************
diff --git a/src/sage/rings/function_field/place_polymod.py b/src/sage/rings/function_field/place_polymod.py
@@ -1,4 +1,7 @@
 # sage.doctest: optional - sage.rings.function_field
+"""
+Places of function fields: extension
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>
diff --git a/src/sage/rings/function_field/place_rational.py b/src/sage/rings/function_field/place_rational.py
@@ -1,4 +1,7 @@
 # sage.doctest: optional - sage.rings.finite_rings       (because all doctests use finite fields)
+"""
+Places of function fields: rational
+"""
 
 #*****************************************************************************
 #       Copyright (C) 2023 Kwankyu Lee <ekwankyu@gmail.com>

-Original file line number
+Diff line change
@@ @@ -1,3 +1,7 @@ @@
 +r"""
 +Derivations of function fields: extension
 +"""
++
 # ****************************************************************************
 #       Copyright (C) 2010      William Stein <[email protected]>
 #                     2011-2017 Julian Rüth <[email protected]>
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+r"""`
	`2`	`+Function Fields: rational`
	`3`	`+"""`
	`4`	`+`
`1`	`5`	`#*****************************************************************************`
`2`	`6`	`# Copyright (C) 2023 Kwankyu Lee <[email protected]>`
`3`	`7`	`#`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+r"""`
	`2`	`+Ideals of function fields: rational`
	`3`	`+"""`
	`4`	`+`
`1`	`5`	`#*****************************************************************************`
`2`	`6`	`# Copyright (C) 2023 Kwankyu Lee <[email protected]>`
`3`	`7`	`#`