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

docs(reference): Copy-edits to reference docs #5447

Closed
wants to merge 1 commit into from

Conversation

Zearin
Copy link
Contributor

@Zearin Zearin commented Oct 9, 2021

Changes:

Lots of copy-edits to the source (docstrings) used to generate the p5.js Reference.

Though numerous, the edits are individually minor. Most are related to formatting or grammar. A few are for phrasing or clarity. I also added a few links to other areas of the reference where appropriate.

PR Checklist

†: Although the lint task completed successfully, the yuidoc:prod task noted that several methods were missing examples. I didn’t remove any examples at all, so I hope this won’t cause an issue with any automated PR testing.

@welcome
Copy link

welcome bot commented Oct 9, 2021

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

@Zearin
Copy link
Contributor Author

Zearin commented Oct 17, 2021

This PR seems to be ignored because I didn’t check the unit tests box in the original post (since unit tests are n/a).

I don’t want this to get too far behind, so I’ll try and check the box to see if this PR gets reviewed by a human...

@Zearin
Copy link
Contributor Author

Zearin commented Oct 17, 2021

Oh. Maybe I should just ping the documentation steward mentioned in the README... :P

@Rahulm2310: Could you review this?

@outofambit
Copy link
Contributor

hey @Zearin, thanks for this! i had already started looking at the changes earlier this week (made it through 12/61 files), but the PR is quite large which makes it a bit hard for someone else to look through and verify or offer feedback on. i saw a lot of nice copyediting for punctuation, etc. and i think some files have more involved changes. Could you list which files have more involved changes or move those into a separate PR? I think that would help us review this faster. thank you!

@Zearin
Copy link
Contributor Author

Zearin commented Nov 21, 2021

@outofambit Thanks. :) It’s been a while. Sorry about the delay! I think I’ll refresh my source and start a new PR with all the easy stuff first.

@Zearin Zearin mentioned this pull request Nov 27, 2021
1 task
@Zearin
Copy link
Contributor Author

Zearin commented Dec 19, 2021

Closing this issue in favor of smaller PRs.

@Zearin Zearin closed this Dec 19, 2021
@Zearin Zearin deleted the docs branch October 8, 2022 15:05
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.

2 participants