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

Clarification of Developer notes for Friendly Error Messaging System (fes_reference_dev_notes.md) #6300

Closed
OnexiMedina opened this issue Jul 27, 2023 · 1 comment · Fixed by #6307

Comments

@OnexiMedina
Copy link
Contributor

Topic

Hello Everyone, I'm a first time contributor looking to work on p5.js!

I was reading through the Developer notes for the Friendly Error Messaging System (fes_reference_dev_notes.md) and noticed some bullet points that I think could use some clarification. In particular, lines number 413 and 446 could be found a bit tricky to understand based on how they are worded. I was wondering if I would be able to open a pull request to make the changes on the documentation.

Below are some screenshots of the bullet points mentioned above as they are in the document, along with the suggested changes.

Line 413

Line 413 FES Docs

This can be changed to:

  • Inline documentation: allowed parameter types are Boolean, Number, String, and name of the object (see the above bullet point). Use Array for any types of array parameters. If needed, explain what specific types of array parameters are allowed (e.g. Number[], String[]) in the description section.

Line 446

Line 446 FES Docs

This can be changed to:

  • FES is only able to detect global variables that have been overwritten if they were declared using const or var. If let is used for variable declaration, they go undetected. This is not currently solvable due to the way let instantiates variables.

Please let me know if this would be of help! Looking forward to hearing back from the community.

@welcome
Copy link

welcome bot commented Jul 27, 2023

Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, please make sure to fill out the inputs in the issue forms. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant