p5.js icon indicating copy to clipboard operation
p5.js copied to clipboard

fix: Correct typo, improve createRadio() method description, and simplify input tag

Open Dhanush111 opened this issue 1 year ago • 3 comments

Related Issue Originally reported in p5.js-website repository: #595 - Misspelling in Docs: Reference > createRadio()

Summary

  • Fixed a typo in the documentation: changed "paremeter" to "parameter" in the description of the myRadio.option() method.
  • Updated the description of the myRadio.disable() method for better clarity:
    • Changed "enables the entire radio button if true is passed and disables it if false is passed." to "Disables the radio button if true is passed, and enables it if false is passed."
  • Simplified the input tag in the documentation:
    • Changed <input name="food"></input> to <input name="food"> since <input> is self-closing.

Motivation These updates improve the clarity, accuracy, and HTML standards compliance of the createRadio documentation, making it easier for developers to understand and implement this method.

Additional Notes Please review the changes to ensure they align with the documentation style and standards of the project.

Dhanush111 avatar Oct 15 '24 20:10 Dhanush111

🎉 Thanks for opening this pull request! Please check out our contributing guidelines if you haven't already. And be sure to add yourself to the list of contributors on the readme page!

welcome[bot] avatar Oct 15 '24 20:10 welcome[bot]

@davepagurek Could you please review this PR? All required changes have been made, and I’m awaiting your feedback for the merge.

Dhanush111 avatar Oct 16 '24 06:10 Dhanush111

@Dhanush111 not sure why you tagged me in this issue as I'm not part of the collaborators here?

bulkan avatar Oct 16 '24 09:10 bulkan

@perminder-17 Yes, i too saw those things were not right, the thing is, I’m having trouble running it locally or on GitHub Pages right now, so I can’t make those changes myself at the moment.

Dhanush111 avatar Oct 20 '24 16:10 Dhanush111