Skip to content

Minor feedback #4

@JohnAAbbott

Description

@JohnAAbbott

Some comments:

  • change example string from "string" to something more obviously distinct from the type String
  • the boolean example could show how both true and false are encoded?
  • is the Int16 example useful?
  • the integer examples could exhibit a value larger than ten (e.g. so that it is clear that a decimal encoding is used)
  • in Vector of integers why is the field params set to Base.Int?
  • in Matrix of integers the typeset form (near the top) is garbled; again Base.Int appears; the actual datum is a Julia matrix, and not an Oscar structure
  • In Dictionary (String to polynomial) there needs to be more explanation; I had expected _refs to appear near the start
  • Need more explanation for Set of polynomial elements; follow guidance to make it easier to associate the encoding with the original values e.g. 3*x and -7*x^2
  • In Integer in ZZ explain difference between BigInt and ZZRingElem
  • The double slash in Rational number is weird: needs explanation/justification
  • problem in One in GF(5): in my browser the page took a long time to finish loading (no idea why); maybe exhibit a value other than one? Perhaps a value greater than half the characteristic (are symmetric or least-non-negative residues used?)
  • In Generator of GF(5^2) the entries in _refs appear to be in reverse order; also needs more explanation
  • In Multivariate polynomial ensure that exponents and coefficients are all distinct (absolute) values.
  • Title Element of residue ring (6) is hard to comprehend; maybe exhibit a different residue class? e.g. 5 or even 11
  • Odd that Univariate polynomial comes after Multivariate polynomial
  • In Rational Matrix the typeset form is garbled; Julia input is hard for non-Julia-experts to read/comprehend
  • In Free abelian group why are the data four zeroes? Needs more explanation
  • In Element of abelian group more explanation is needed: why are the data 1 and 0?
  • In Subgroup of symmetric group explain what attrs are

Stopping here: there is much more to check... don't have time now.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions