engaging-computing / engaging-computing/MYR

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

Open
#623 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement Reference
Dominant language
JavaScript
Stars
24
Forks
22
PR merge metrics
No merged PRs in 30d

Description

## 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](https://user-images.githubusercontent.com/53062712/184231801-fe27350c-fb79-4edd-a667-fd61cbb736bf.png)

## 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`

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.