Skip to content

A few documentation issues to fix #8031

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

Open
wants to merge 24 commits into
base: dev-2.0
Choose a base branch
from

Conversation

perminder-17
Copy link
Collaborator

@perminder-17 perminder-17 commented Aug 16, 2025

Here's are some of the specific updates to make:

  • Document the default value of the ends property (the default is INCLUDE), at least on the splineProperty() page. The splineProperties() page can link to that.
  • Replace the broken link to curve() with a link to spline(), on the splineVertex() page.
  • Fix spline() examples.
  • Fix splinePoint() examples.
  • Fix splineTangent() examples.
  • Add code example for the ends property to the splineProperty() page.
  • Typos, language cleanup 1 (since language complexity and typos affect accessibility)
  • Revise top-line descriptions that appear on the main reference page? For example, for splineVertex(), we might replace "Adds a spline curve segment to a custom shape" with "Connects points with a smooth curve (a spline)." This is less pressing, but a more beginner-friendly explanation focused on the main use case may improve discoverability significantly.

@perminder-17 perminder-17 changed the base branch from main to dev-2.0 August 16, 2025 23:17
@perminder-17 perminder-17 marked this pull request as draft August 16, 2025 23:24
@perminder-17 perminder-17 added this to the 2.1 milestone Aug 16, 2025
@perminder-17 perminder-17 marked this pull request as ready for review August 17, 2025 22:30
@perminder-17
Copy link
Collaborator Author

Hi @GregStanton, thank you for your comment on this issue (link). It helped me make a clear checklist, and I believe I’ve fixed the points you mentioned. I’m also checking the math parts to see what might be missing.

If you know any other examples, docs, or tutorials that need updates, please let me know and I’ll fix them quickly. If you have time, your review on this PR would be very helpful for future readers. I’m happy to improve anything else you suggest. Thanks again!

For reference, here’s the code I’m using for ends (INCLUDE/EXCLUDE): https://editor.p5js.org/aman12345/sketches/wXMOd_gxe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

1 participant