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

Parameters of type "elementID" in MYR are shown as strings #623

Open
rjmara opened this issue Aug 11, 2022 · 0 comments
Open

Parameters of type "elementID" in MYR are shown as strings #623

rjmara opened this issue Aug 11, 2022 · 0 comments
Labels

Comments

@rjmara
Copy link
Contributor

rjmara commented Aug 11, 2022

Description

In the references page, when hovering over functions that take an elementID as a parameter, it is shown that the type is a string. However, for some of these elementIDs, you either use groups or a function of the element itself, such as box(). This makes it unclear to the user because an elementID is not encapsulated by quotation marks and is usually an object you can see on the screen.

image

Potential Solution

Instead of having the attribute shown as a string, we can create a new attribute called elementID that shows a clear difference between a string and elements.

Additional Context

Most changes for this would be done in /src/myr/reference.js but one change for adding the elementID to the key in references would be done in /src/components/Reference.js

@rjmara rjmara changed the title parameters of type "elementID" in MYR are shown as strings Parameters of type "elementID" in MYR are shown as strings Aug 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Issues
Development

No branches or pull requests

1 participant