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

Totally omit a class' mermaid diagram if there are more than n slots #453

Closed
turbomam opened this issue Sep 12, 2022 · 5 comments · Fixed by #1625
Closed

Totally omit a class' mermaid diagram if there are more than n slots #453

turbomam opened this issue Sep 12, 2022 · 5 comments · Fixed by #1625
Assignees
Labels

Comments

@turbomam
Copy link
Member

turbomam commented Sep 12, 2022

Possible N = 60 (or whatever fits vertically on one average screen)

In the future, we might think about ways to show the structural part of the mermaid diagram without the slots, but just omitting diagrams with excessive slots is a good start.

@turbomam
Copy link
Member Author

turbomam commented Sep 12, 2022

@turbomam
Copy link
Member Author

turbomam commented Sep 12, 2022

@turbomam
Copy link
Member Author

turbomam commented Nov 6, 2023

@sujaypatil96
Copy link
Collaborator

In this issue we're saying that we should use one parameter, the total number of slots associated with a class to decide whether the Mermaid UML diagram should be rendered on a class documentation page or not.

I'm proposing that we add three more parameters to make this decision. They are:

  • Number of edges between given class (in consideration) and is_a parents
  • Number of edges between given class (in consideration) and is_a children
  • Number of edges between given class (in consideration) and other classes that are linked/associated based on a slot

@sujaypatil96
Copy link
Collaborator

The above has been implemented in PR #1625 in class_diagram.md.jinja2

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

Successfully merging a pull request may close this issue.

2 participants