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

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

Open Dhanush111 opened this issue 1 year ago • 4 comments

Related Issue

Fixes #595 - Mispelling in Docs: Reference > createRadio()

Summary

  • Corrected a typo in the documentation: changed "paremeter" to "parameter" in the description of the myRadio.option() method.
  • Improved the description of the myRadio.disable() method:
    • 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 HTML tag example in the documentation:
    • Changed <input name="food"></input> to <input name="food"> since <input> is a self-closing tag.

Motivation

These changes enhance the readability, accuracy, and compliance with HTML standards in the createRadio documentation, making it easier for developers to understand and use this method.

Additional Notes

Please review these changes to ensure they align with the project's documentation style.

Dhanush111 avatar Oct 15 '24 17:10 Dhanush111

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

Dhanush111 avatar Oct 15 '24 17:10 Dhanush111

@kjhollen Hi, I noticed that the status checks are still pending. Is there an issue with the CI/CD process? Please let me know if I can assist in any way.

Dhanush111 avatar Oct 15 '24 17:10 Dhanush111

Hi @Dhanush111! English docs actually come from the p5.js repo, so any changes made directly here will get overwritten in the next release. Could you make your changes there instead?

If you want to see where the docs live in the p5.js repo, there's actually a link you can follow at the bottom of every reference page: Screenshot 2024-10-15 at 2 55 59 PM

davepagurek avatar Oct 15 '24 18:10 davepagurek

@davepagurek Hi! Thank you for the clarification. I appreciate your guidance. I've made the necessary changes in the p5.js repository, and you can find my pull request here: #7315. Please let me know if there's anything else I need to address or modify. Thank you!

Dhanush111 avatar Oct 15 '24 20:10 Dhanush111

Fixed in https://github.com/processing/p5.js/pull/7315. Thanks.

limzykenneth avatar Jan 31 '25 12:01 limzykenneth