Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OSCAR style guide #4

Open
pbelmans opened this issue Aug 23, 2024 · 0 comments
Open

OSCAR style guide #4

pbelmans opened this issue Aug 23, 2024 · 0 comments
Labels
question Further information is requested

Comments

@pbelmans
Copy link
Member

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.

@pbelmans pbelmans added the question Further information is requested label Aug 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant