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

Documentation embedded in the hover popup is broken in some cases #260

Closed
lesquoyb opened this issue Jul 15, 2024 · 1 comment
Closed

Documentation embedded in the hover popup is broken in some cases #260

lesquoyb opened this issue Jul 15, 2024 · 1 comment
Labels
About Doc This issue concerns the documentation of GAMA About UI This is an UI-related issue or request 😱 Bug The issue reveals a bug in GAMA 👍 Fix to be tested

Comments

@lesquoyb
Copy link
Contributor

Describe the bug
I noticed that the documentation of the image layer in the popup window that appears on hovering the image keyword seems broken:
It includes the titles of the usage parts of the documentation without the actual examples, which is really weird:
image

To Reproduce
Steps to reproduce the behavior:

  1. write an image layer in a display
  2. hover over the image keyword with your mouse
  3. See error

Expected behavior
Either the Usage part is completely ignored, or it is displayed including the examples.
Another alternative would be to write the documentation a bit differently so it won't feel weird to only have the value of usage and not the examples, but I think in that case there's probably a lot of statements and operators to redo.

@lesquoyb lesquoyb added 😱 Bug The issue reveals a bug in GAMA About UI This is an UI-related issue or request labels Jul 15, 2024
@AlexisDrogoul AlexisDrogoul added the About Doc This issue concerns the documentation of GAMA label Aug 31, 2024
@AlexisDrogoul
Copy link
Member

Should be fixed by 45808cb . Please test.

@lesquoyb lesquoyb moved this from Todo to Done in GAMA 2024-11 Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
About Doc This issue concerns the documentation of GAMA About UI This is an UI-related issue or request 😱 Bug The issue reveals a bug in GAMA 👍 Fix to be tested
Projects
Status: Done
Development

No branches or pull requests

2 participants