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

Documentation for createVideo and createAudio should link to MediaElement #5355

Closed
1 of 17 tasks
guilhermesilveira opened this issue Jul 17, 2021 · 1 comment · Fixed by #5356
Closed
1 of 17 tasks
Labels

Comments

@guilhermesilveira
Copy link
Contributor

Most appropriate sub-area of p5.js?

  • Accessibility (Web Accessibility)
  • Build tools and processes
  • Color
  • Core/Environment/Rendering
  • Data
  • DOM
  • Events
  • Friendly error system
  • Image
  • IO (Input/Output)
  • Localization
  • Math
  • Unit Testing
  • Typography
  • Utilities
  • WebGL
  • Other (specify if possible)
    Documentation

Details about the bug:

  • p5.js version: Current main branch
  • Web browser and version: does not apply
  • Operating System: does not apply
  • Steps to reproduce this:

While createImage correctly states that it returns p5.Image and links to the proper page, the p5.MediaElement creators link to Element, giving a false understanding that there are not extra methods to MediaElement.

The createImage return documentation is here:

The wrong links are here:

I understand the links are not technically wrong per se, but they are more helpful if they link to the more specific p5.MediaElement instead of p5.Element.

@welcome
Copy link

welcome bot commented Jul 17, 2021

Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, be sure to follow the issue template if you haven't already.

guilhermesilveira added a commit to guilhermesilveira/p5.js that referenced this issue Jul 17, 2021
Both createVideo and createAudio return p5.MediaElements, so the documentation is updated accordingly.
outofambit added a commit that referenced this issue Aug 18, 2021
fixing links to p5.MediaElement - resolves #5355
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant