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

visualization: display state reads and writes on newline #402

Open
zilto opened this issue Oct 17, 2024 · 0 comments
Open

visualization: display state reads and writes on newline #402

zilto opened this issue Oct 17, 2024 · 0 comments
Labels
enhancement New feature or request visualization

Comments

@zilto
Copy link
Collaborator

zilto commented Oct 17, 2024

It's useful to be able to see how an action interacts with the State. However, the current visualization tries to display the action's name, reads, and writes on the same line, which rapidly increases the figure's size and reduces readability.

For example, this only has 1 to 3 reads + writes:

Proposed solution

Make reads start on a newline and writes on another newline. We will need to indicate if it's a read or write for the first item of each section. Here are some examples:

No reads/writes

action_name

Only reads

action_name
reads:
  read_1
  read_2

Only writes

action_name
writes:
   write_1
   write_2

With reads and writes

action_name
reads:
  read_1
writes:
  write_1

Keeping the same font for all items helps with readability. The value for action_name could be bolded

@zilto zilto added enhancement New feature or request visualization labels Oct 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request visualization
Projects
None yet
Development

No branches or pull requests

1 participant