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

legend: fix description of documented items for plain shape #10287

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

makelinux
Copy link
Contributor

for configurations:

  • DOT_NODE_ATTR = shape=plaintext
  • DOT_NODE_ATTR = shape=plain

Preview of DOT_NODE_ATTR = shape=plaintext:
image

@makelinux makelinux changed the title legend: fix description of documented items legend: fix description of documented items for plain shape Sep 6, 2023
Comment on lines 1042 to 1050
"The nodes in the above graph have the following meaning:\n"
"</p>\n"
"<ul>\n"
"<li>%A filled gray box represents the struct or class for which the "
"graph is generated.</li>\n"
"<li>%A box with a black border denotes a documented struct or class.</li>\n"
+ (Config_getString(DOT_NODE_ATTR).contains("shape=plain")?
"<li>Name in regular font ":"<li>%A box with a black border ") +
"denotes a documented struct or class.</li>\n"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Line 1042 you changed "boxes" to "nodes" but in line 1048 you used "box" again, also in the original text there are more occurrences of "box".
I also think that "node" / "nodes" is a bit an abstract term for the users that read the the diagram whilst wit the word "box" / "boxes" they straight away have a visual feedback.
(It is always difficult to get the right terms).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A text "A box with a black border" is the old text from previous line 1047. It is printed for default configuration "shape=box".
The patch follows rule: "Preserve the default behaviour".
The patch writes "Name in regular font" only when node configuration is "shape=plain" or "shape=plaintext".
The rest of nodes are represented with filled boxes anytime. For "shape=plain" without border.

for configurations:
- DOT_NODE_ATTR = shape=plaintext
- DOT_NODE_ATTR = shape=plain
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants