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

Improvement of layout of model relations. #7395

Closed
albert-github opened this issue Apr 18, 2023 · 3 comments · Fixed by #7576
Closed

Improvement of layout of model relations. #7395

albert-github opened this issue Apr 18, 2023 · 3 comments · Fixed by #7576

Comments

@albert-github
Copy link
Contributor

albert-github commented Apr 18, 2023

After successful implementation of the adjusted documentation approach for refines (see #7236 and #7231), it would also be good to have a look at other possible candidates, especially the \cgalHasModel and \cgalModel. like in Algebraic_foundations/classFieldNumberType.html:

image

and in the "treeview" the part:
image

The questions that arise:

  1. would this be useful, in my opinion YES
  2. in general types in "Has Model" should appear in "code" format (so between backticks) should "simple" types like "float" and "double" also appear here in "code" format
  3. should Has Model Relationships appear in the "treeview"
  4. should Is Model Relationships appear in the "treeview"
@albert-github
Copy link
Contributor Author

Any comments?

@sloriot
Copy link
Member

sloriot commented Jul 3, 2023

I 100% agree to do the same thing, it is useless in my opinion to have such pages and even more in the treeview.

albert-github added a commit to albert-github/cgal that referenced this issue Jul 5, 2023
Consistent implementation for the `AABB_tree` in respect to `Has Model` and `Is Model Of`
@albert-github
Copy link
Contributor Author

As a start I've just pushed a proposed patch, pull request #7576 for the AABB_tree so the results can be checked on "problems" before implementing it with the other packages.

@lrineau lrineau linked a pull request Jul 5, 2023 that will close this issue
albert-github added a commit to albert-github/cgal that referenced this issue Jul 6, 2023
- Completed the cgalHasModel part
- corrected spelling of `Has Model` and `Is Model Of` to `Has model` and `Is model of`
albert-github added a commit to albert-github/cgal that referenced this issue Jul 9, 2023
albert-github added a commit to albert-github/cgal that referenced this issue Jul 15, 2023
albert-github added a commit to albert-github/cgal that referenced this issue Jul 15, 2023
albert-github added a commit to albert-github/cgal that referenced this issue Jul 18, 2023
Corrected `cgalModels` to `cgalHasModes` inside `cgalHasNodelsBegin` / `cgalHasModelsEnd`
albert-github added a commit to albert-github/cgal that referenced this issue Jul 21, 2023
albert-github added a commit to albert-github/cgal that referenced this issue Jul 21, 2023
Replacing the `cgalModelsBare` construct with a `begin` / `end` construct so no less understandable constructs with `\,` and `\n` are necessary.
lrineau added a commit that referenced this issue Sep 7, 2023
issue #7395 Improvement of layout of model relations

# Conflicts:
#	Kernel_23/doc/Kernel_23/CGAL/Vector_2.h
albert-github added a commit to albert-github/cgal that referenced this issue Oct 9, 2023
removing files that were removed by CGAL#7445 but reintroduced by CGAL#7395
@MaelRL MaelRL added this to the 6.0-beta milestone Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants