Rename lalib.elements.gf2.GF2 & friends
- the future (concrete) Galois `Field` implementation
shall receive the name `GF2` (as per common math notation)
=> name conflict with the current `GF2` class
implementing the elements of the future Galois `Field`
=> rename the current `GF2` class into `GF2Element`
- because `GF2Element` is a bit tedius to type for the end user,
we introduce a `gf2` alias in line with the naming convention
for the built-in data types (e.g., `int` or `float`)
that are also used as elements of (other) `Field`s
=> name conflict with the current `lalib.elements.gf2` module
=> rename the module into `lalib.elements.galois`
- adjust the docstrings to refer to "the `gf2` type"
- adjust the top-level imports and tests
This commit is contained in:
parent
65de932f8d
commit
917c217ca0
5 changed files with 89 additions and 78 deletions
|
|
@ -15,7 +15,7 @@ import xdoctest
|
|||
[
|
||||
"lalib",
|
||||
"lalib.elements",
|
||||
"lalib.elements.gf2",
|
||||
"lalib.elements.galois",
|
||||
],
|
||||
)
|
||||
def test_docstrings(module):
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue