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

Add preview pictures to rewrites #309

Merged
merged 16 commits into from
Jul 16, 2024
Merged

Add preview pictures to rewrites #309

merged 16 commits into from
Jul 16, 2024

Conversation

jvdwetering
Copy link
Collaborator

@jvdwetering jvdwetering commented Jul 10, 2024

Made it so when you hover over a rewrite in the big list, it shows a preview picture. This also works for custom rewrites. These are just pictures and not gifs, as that was too hard to do.
A couple of things I leave open for now:

  1. Currently I've manually made pictures based on papers that show the rewrite. The benefit of this is that this can show stuff like 'dot-dot-dots' to denote more symbolically what the rewrite does. The drawback is that if the user changes the colour style of the diagrams, that the previouw picture does not match what is shown in ZXLive. A solution to this would be to automatically generate a preview picture based on what is in ZXLive, but this is very high effort.
  2. We need to decide whether we want every rewrite to have an associated picture, or only some that are potentially more difficult to understand.

@RazinShaikh
Copy link
Collaborator

Can you add an option to enable or disable previews in settings?

@RazinShaikh
Copy link
Collaborator

Regarding 3, previews for custom rewrites are quite necessary. I often forget what the rewrite is supposed to do and then I need to open the actual file to check.

@jvdwetering
Copy link
Collaborator Author

I made it a toggleable setting, but it only applies to a newly opened proof tab, but that's probably fine.

@boldar99
Copy link
Collaborator

The files in the tooltips folder need to be added to MANIFEST.in so that those files are also distributed with pip.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Just wondering if this file with 41,595 lines should be pushed to the repo. It looks like it was auto-generated.

zxlive/settings_dialog.py Outdated Show resolved Hide resolved
@jvdwetering jvdwetering marked this pull request as ready for review July 16, 2024 23:28
@jvdwetering jvdwetering merged commit 6d99563 into master Jul 16, 2024
2 checks passed
@jvdwetering jvdwetering deleted the feature/previews branch July 16, 2024 23:47
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.

3 participants