cgal icon indicating copy to clipboard operation
cgal copied to clipboard

documentation of "int.h" and "long_long.h"

Open albert-github opened this issue 2 years ago • 0 comments

When looking at the documentation of long_long.h (Number_types/long__long_8h.html) we see: image

wouldn't it be better to have the descriptive sentence:

This header provides all necessary functions so the fundamental type long long int is an RealEmbeddable EuclideanRing.

be more inline with `"float.h" / double.h" so:

This header provides all necessary functions so the fundamental type long long int is a model of the concepts RealEmbeddable and EuclideanRing.

and when looking at the documentation of int.h (Number_types/int_8h.html) we see: image

  • wouldn't it be better to have the descriptive sentence more inline with the other numerical types?
  • wouldn't it be better to change the lines like: image into lines with just the type and followed by: image

albert-github avatar Oct 10 '23 13:10 albert-github