Update the banners in examples (#1304)

* update banner in examples * add msets to html docs
thofma · Dec 1, 2023 · c983aa9 · c983aa9
1 parent 5acd127
commit c983aa9
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -69,28 +69,32 @@ Here is a quick example of using Hecke:
 
 ```julia
 julia> using Hecke
-...
 
 Welcome to
 
-  _    _           _
- | |  | |         | |
- | |__| | ___  ___| | _____
- |  __  |/ _ \/ __| |/ / _ \
- | |  | |  __/ (__|   <  __/
- |_|  |_|\___|\___|_|\_\___|
+    _    _           _
+   | |  | |         | |
+   | |__| | ___  ___| | _____
+   |  __  |/ _ \/ __| |/ / _ \
+   | |  | |  __/ (__|   <  __/
+   |_|  |_|\___|\___|_|\_\___|
+
+Version 0.22.8...
+ ... which comes with absolutely no warranty whatsoever
+(c) 2015-2023 by Claus Fieker, Tommy Hofmann and Carlo Sircana
 
-Version 0.10.12...
- ... which comes with absolutely no warrant whatsoever
-(c) 2015-2019 by Claus Fieker, Tommy Hofmann and Carlo Sircana
 
 julia> Qx, x = polynomial_ring(FlintQQ, "x");
+
 julia> f = x^3 + 2;
+
 julia> K, a = number_field(f, "a");
+
 julia> O = maximal_order(K);
+
 julia> O
-Maximal order of Number field over Rational Field with defining polynomial x^3 + 2
-with basis [1,a,a^2]
+Maximal order of Number field of degree 3 over QQ
+with basis nf_elem[1, a, a^2]
 ```
 
 ## Documentation

diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -114,6 +114,7 @@ nav:
       - Misc: misc.md
     - Extra features:
       - Macros: features/macros.md
+      - Multi-sets: features/mset.md
     - References: 'references.md'
     - Examples: 'examples.md'
     - Developer:

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -42,40 +42,48 @@ Here is a quick example of using Hecke:
 
 ```julia
 julia> using Hecke
-...
 
 Welcome to
 
-  _    _           _
- | |  | |         | |
- | |__| | ___  ___| | _____
- |  __  |/ _ \/ __| |/ / _ \
- | |  | |  __/ (__|   <  __/
- |_|  |_|\___|\___|_|\_\___|
+    _    _           _
+   | |  | |         | |
+   | |__| | ___  ___| | _____
+   |  __  |/ _ \/ __| |/ / _ \
+   | |  | |  __/ (__|   <  __/
+   |_|  |_|\___|\___|_|\_\___|
 
-Version 0.9.0 ...
+Version 0.22.8...
  ... which comes with absolutely no warranty whatsoever
-(c) 2015-2018 by Claus Fieker, Tommy Hofmann and Carlo Sircana
+(c) 2015-2023 by Claus Fieker, Tommy Hofmann and Carlo Sircana
+
 
 julia> Qx, x = polynomial_ring(FlintQQ, "x");
+
 julia> f = x^3 + 2;
+
 julia> K, a = number_field(f, "a");
+
 julia> O = maximal_order(K);
+
 julia> O
-Maximal order of Number field over Rational Field with defining polynomial x^3 + 2
-with basis [1,a,a^2]
+Maximal order of Number field of degree 3 over QQ
+with basis nf_elem[1, a, a^2]
 ```
 
 The documentation of the single functions can also be accessed at the julia prompt. Here is an example:
 
 ```
-help?> signature
-search: signature
+help?> absolute_degree
+search: absolute_degree absolute_inertia_degree absolute_coordinates is_absolutely_irreducible
+
+  absolute_degree(a::FqField)
+
+  Return the degree of the given finite field over the prime field.
 
-  ----------------------------------------------------------------------------
+  ─────────────────────────────────────────────────────────────────────────────────────────────────
 
-  signature(O::NfMaximalOrder) -> Tuple{Int, Int}
+  absolute_degree(L::NumField) -> Int
 
-  |  Returns the signature of the ambient number field of \mathcal O.
+  Given a number field L/K, this function returns the degree of L over \mathbf Q.
 ```