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

Correct documentation mistakes in double.h and long_double.h #8729

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

LeoValque
Copy link

@LeoValque LeoValque commented Feb 6, 2025

Release Management

@MaelRL
Copy link
Member

MaelRL commented Feb 6, 2025

It should even be FieldWithKthRoot, and not just FieldWithSqrt.

@albert-github
Copy link
Contributor

Note a possible related issue is #7782

@LeoValque
Copy link
Author

I did the modification, now the PR also solved issue 7782

@albert-github
Copy link
Contributor

I don't yet see a change for int.h which look to me still a bit out of sync.

@@ -11,4 +11,5 @@ This header provides all necessary functions so the fundamental types
Copy link
Contributor

@albert-github albert-github Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the above lines still necessary or should they be reformulated?

Copy link
Member

@MaelRL MaelRL Feb 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that documentation page (see https://doc.cgal.org/latest/Number_types/int_8h.html) is not only for int, but also for short int and long int. It's not the documentation of a specific type like the others but of a header. Looking at the complete doc, I would have in fact gone the opposite way and removed all the cgalModels from these header documentations...

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did the suggestion of Mael, now there is only one sentence instead of four identicals.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't there be something like:

\cgalModels{RealEmbeddable,EuclideanRing}

as well, so it is consistent with the other files?

I think the \cgalModels{RealEmbeddable,EuclideanRing} is good to have as you see it at once and don't have to look through the text (although this is quite small in this case)

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I aggry I understand the suggestion of mael as removing the three sentences "int is model of ..., short int is model of ..., ..., long int is model of ...".
I think it is good not to waste too much energy on these very small files. If you think that the actual change does not miss anything important, we can close the case.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is good not to waste too much energy on these very small files.

I understand what you are saying, but consistency is a great thing, quite often the first impression that a user gets is through the documentation. Also consistency can make things easier in the future. So it looks like wasting time but I think it pays off in the long run.

Copy link
Member

@lrineau lrineau Feb 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\cgalModels{RealEmbeddable,EuclideanRing} displays:

Is model of

That is appropriate for a documentation page about one single entity. But here CGAL/int.h is about multiple integral types and \cgalModels cannot be used, unfortunately.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it just the word "Is" that should be "Are" or is it more fundamental?

  • In the first case a second ALIASES would do.
  • In the fundamental case I don't see a quick solution (I don't need the fundamental explanation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Discrepancy in documentation of "float.h", "double.h" and "long_double.h"
5 participants