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

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Dhanush111
Copy link

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.

…cription

- 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."
- These changes improve the readability and accuracy of the documentation for createRadio.
@Dhanush111
Copy link
Author

@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
Copy link
Author

@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 Dhanush111 closed this Oct 15, 2024
@Dhanush111 Dhanush111 reopened this Oct 15, 2024
@davepagurek
Copy link
Collaborator

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

@Dhanush111
Copy link
Author

@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!

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

Successfully merging this pull request may close these issues.

Mispelling in Docs: Reference > createRadio()
2 participants