Follow-up to #5083: Minor Doc Fixes

experimental/FTheoryTools/src/AbstractFTheoryModels/basic_attributes.jl

@@ -3,6 +3,7 @@
 
 Return the base space of the F-theory model.
 
+# Examples
 ```jldoctest
 julia> m = literature_model(arxiv_id = "1109.3454", equation = "3.1")
 Assuming that the first row of the given grading is the grading under Kbar
@@ -24,6 +25,7 @@ end
 
 Return the ambient space of the F-theory model.
 
+# Examples
 ```jldoctest
 julia> m = literature_model(arxiv_id = "1109.3454", equation = "3.1")
 Assuming that the first row of the given grading is the grading under Kbar
@@ -45,6 +47,7 @@ end
 
 Return the fiber ambient space of an F-theory model.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -72,6 +75,7 @@ end
 Return database index of a literature model. This index is a unique identifier that can be used to more conveniently construct the model. 
 All models have a model_index and these will not change in the future.
 
+# Examples
 ```jldoctest
 julia> t = literature_model(31)
 Assuming that the first row of the given grading is the grading under Kbar

experimental/FTheoryTools/src/AbstractFTheoryModels/computed_attributes.jl

@@ -20,6 +20,7 @@ be switched off by setting the optional argument `check` to the value `false`, a
     Internally, we integrate those ambient space classes against the class of the hypersurface, which automatically
     executes the restriction to the hypersurface.
 
+# Examples
 ```jldoctest; setup = :(Oscar.LazyArtifacts.ensure_artifact_installed("QSMDB", Oscar.LazyArtifacts.find_artifacts_toml(Oscar.oscardir)))
 julia> qsm_model = literature_model(arxiv_id = "1903.00009", model_parameters = Dict("k" => 4))
 Hypersurface model over a concrete base
@@ -93,6 +94,7 @@ The theory guarantees that the implemented algorithm works for toric ambient spa
 simplicial and complete. The check for completeness can be very time consuming. This check can
 be switched off by setting the optional argument `check` to the value `false`, as demonstrated below.
 
+# Examples
 ```jldoctest; setup = :(Oscar.LazyArtifacts.ensure_artifact_installed("QSMDB", Oscar.LazyArtifacts.find_artifacts_toml(Oscar.oscardir)))
 julia> qsm_model = literature_model(arxiv_id = "1903.00009", model_parameters = Dict("k" => 4))
 Hypersurface model over a concrete base
@@ -128,6 +130,7 @@ as a hypersurface in a toric ambient space, we can compute the Euler characteris
 assumptions is satisfied, this method returns the Euler characteristic, otherwise it raises an
 error.
 
+# Examples
 ```jldoctest; setup = :(Oscar.LazyArtifacts.ensure_artifact_installed("QSMDB", Oscar.LazyArtifacts.find_artifacts_toml(Oscar.oscardir)))
 julia> qsm_model = literature_model(arxiv_id = "1903.00009", model_parameters = Dict("k" => 4))
 Hypersurface model over a concrete base

experimental/FTheoryTools/src/AbstractFTheoryModels/methods.jl

@@ -8,6 +8,7 @@
 
 Resolve an F-theory model by blowing up a locus in the ambient space.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -25,6 +26,7 @@ Partially resolved global Tate model over a concrete base -- SU(5)xU(1) restrict
 ```
 Here is an example for a Weierstrass model.
 
+# Examples
 ```jldoctest
 julia> B2 = projective_space(NormalToricVariety, 2)
 Normal toric variety
@@ -53,6 +55,7 @@ end
 
 Resolve an F-theory model by blowing up a locus in the ambient space.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -109,6 +112,7 @@ end
 Resolve an F-theory model by blowing up a locus in the ambient space.
 For this method, the blowup center is encoded by an ideal sheaf.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -264,6 +268,7 @@ end
 # Note that there is less functionality for hypersurface models than for Weierstrass or Tate
 # models. For instance, `singular_loci` can (currently) not be computed for hypersurface models.
 
+# # Examples
 # ```jldoctest
 # julia> B3 = projective_space(NormalToricVariety, 3)
 # Normal toric variety
@@ -326,6 +331,7 @@ Put an F-theory model defined over a family of spaces over a concrete base.
 
 Currently, this functionality is limited to Tate and Weierstrass models.
 
+# Examples
 ```jldoctest
 julia> t = literature_model(arxiv_id = "1109.3454", equation = "3.1", completeness_check = false)
 Assuming that the first row of the given grading is the grading under Kbar
@@ -498,7 +504,7 @@ end
 @doc raw"""
     add_associated_literature_model(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of associated literature models for the F-theory model.
+Add a new entry to the list of associated literature models for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -512,7 +518,7 @@ end
 @doc raw"""
     add_journal_report_number(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of journal report numbers for the F-theory model.
+Add a new entry to the list of journal report numbers for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -526,7 +532,7 @@ end
 @doc raw"""
     add_model_parameter(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of model parameters for the F-theory model.
+Add a new entry to the list of model parameters for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -540,7 +546,7 @@ end
 @doc raw"""
     add_paper_author(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of paper authors for the F-theory model.
+Add a new entry to the list of paper authors for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -554,7 +560,7 @@ end
 @doc raw"""
     add_paper_buzzword(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of paper buzzwords for the F-theory model.
+Add a new entry to the list of paper buzzwords for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -568,7 +574,7 @@ end
 @doc raw"""
     add_birational_literature_model(m::AbstractFTheoryModel, addition::String)
 
-Adds a new entry to the list of birational models for the F-theory model.
+Add a new entry to the list of birational models for the F-theory model.
 If the entry is already present, nothing is changed.
 
 See [Literature Models](@ref literature_models) for more details.
@@ -597,6 +603,7 @@ end
 
 Add a known resolution for a model.
 
+# Examples
 ```jldoctest
 julia> m = literature_model(arxiv_id = "1109.3454", equation = "3.1")
 Assuming that the first row of the given grading is the grading under Kbar
@@ -678,6 +685,7 @@ end
 
 Resolve a model with the index-th resolution that is known.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety

experimental/FTheoryTools/src/AbstractFTheoryModels/precomputed_attributes.jl

@@ -44,6 +44,7 @@ Return the cohomology classes of the exceptional toric divisors of a model as a
 This information is only supported for models over a concrete base that is a normal toric variety, but is always available in this case.
 After a toric blow up this information is updated.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -77,6 +78,7 @@ Return the indices of the generators of the Cox ring of the ambient space which
 This information is only supported for models over a concrete base that is a normal toric variety, but is always available in this case.
 After a toric blow up this information is updated.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety

experimental/FTheoryTools/src/AbstractFTheoryModels/properties.jl

@@ -7,6 +7,7 @@
 
 Return `true` if the F-theory model has a concrete base space and `false` otherwise.
 
+# Examples
 ```jldoctest
 julia> t = literature_model(arxiv_id = "1109.3454", equation = "3.1")
 Assuming that the first row of the given grading is the grading under Kbar
@@ -26,6 +27,7 @@ is_base_space_fully_specified(m::AbstractFTheoryModel) = !(m.base_space isa Fami
 Return `true` if resolution techniques were applied to the F-theory model,
 thereby potentially resolving its singularities. Otherwise, return `false`.
 
+# Examples
 ```jldoctest
 julia> B3 = projective_space(NormalToricVariety, 3)
 Normal toric variety
@@ -65,6 +67,7 @@ If so, this method returns `true`. However, should information be missing, (e.g.
 Hodge numbers), or the dimension of the F-theory model differ form 4, then this method
 raises an error.
 
+# Examples
 ```jldoctest; setup = :(Oscar.LazyArtifacts.ensure_artifact_installed("QSMDB", Oscar.LazyArtifacts.find_artifacts_toml(Oscar.oscardir)))
 julia> qsm_model = literature_model(arxiv_id = "1903.00009", model_parameters = Dict("k" => 4))
 Hypersurface model over a concrete base
@@ -108,6 +111,7 @@ of a cohomology class ``h`` on the toric ambient space. This in turn requires th
 toric ambient space is simplicial and complete. We provide a switch to turn off 
 these computationally very demanding checks. This is demonstrated in the example below.
 
+# Examples
 ```jldoctest; setup = :(Oscar.LazyArtifacts.ensure_artifact_installed("QSMDB", Oscar.LazyArtifacts.find_artifacts_toml(Oscar.oscardir)))
 julia> qsm_model = literature_model(arxiv_id = "1903.00009", model_parameters = Dict("k" => 4))
 Hypersurface model over a concrete base