Oscar.jl icon indicating copy to clipboard operation
Oscar.jl copied to clipboard

Naming conventions and strategies throughout OSCAR

Open HereAround opened this issue 2 years ago • 5 comments

For consistency and user friendliness across the many different areas of OSCAR, it might be good to discuss and ideally agree on the following.

Naming conventions:

  • quotient_ring vs. quo,
  • residue_ring vs. quo,
  • subscheme vs. sub or closed_sub,
  • hypersurface_complement vs. open_sub,
  • ambient_affine_space vs. ambient_space (is affine not implicitly clear?)
  • ...

Strategies:

  • specifying many variable names (multivariate polynomial ring, graded ring, finitely presented groups, schemes, toric varieties, ...)
  • ...

HereAround avatar Nov 11 '22 15:11 HereAround

I don't think the soon to be introduced quotient_ring has any relation to quo, since it takes only one argument (the ring).

thofma avatar Nov 11 '22 16:11 thofma

On Fri, Nov 11, 2022 at 08:02:24AM -0800, Tommy Hofmann wrote:

I don't think the soon to be introduced quotient_ring has any relation to quo.

I think it has - and there are already various quotient_rings that sneaked in...

-- Reply to this email directly or view it on GitHub: https://github.com/oscar-system/Oscar.jl/issues/1714#issuecomment-1311889748 You are receiving this because you are subscribed to this thread.

Message ID: @.***>

fieker avatar Nov 11 '22 16:11 fieker

I think that we should have this discussion in person -- not with erveryone typing in a github issue (and maybe only sum up the results here afterwards for later reference).

To your examples above just one remark: A hypersurface_complement of an affine variety is much more specific than a Zariski open subset of it; only the former carries the structure of an affine variety itself.

afkafkafk13 avatar Nov 13 '22 22:11 afkafkafk13

Another one: complement_of_ideal -> complement maybe?

fingolfin avatar Nov 17 '22 10:11 fingolfin

Some first steps have been taken in #1738 .

HechtiDerLachs avatar Nov 18 '22 17:11 HechtiDerLachs