Skip to content

OSCAR style guide #4

@pbelmans

Description

@pbelmans

We are aware of the Julia style guide and (largely) follow it, but it's probably a good idea to take a look at the OSCAR style guide.

Based on these, I wonder whether the following should be considered:

  • have a DimensionVector type, and likewise a StabilityParameter type? the latter would also work with things more general than integers, we should at least allow rational numbers? it's a though one, because in Sage I would argue against it, but maybe in Julia it makes sense, as there's so little overhead?
  • why Teleman_bound_onstratum and not Teleman_bound_on_stratum?
  • there are spurious / missing new lines everywhere: this should be more consistent
  • it should be n_vertices (and be an alias for number_of_vertices)

Related to this I have the following questions about the structure of the code:

  • maybe Chow-related things should be put in chow.jl, given how hard it is to navigate moduli.jl given its size
  • for clarity, shouldn't there be a quiver.jl file with things that are currently in QuiverTools.jl and QuiverTools-types.jl?

There might be more to come as I ponder these questions a bit more.

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions