Skip to content

Set appropriate default instance names for the 'syntax' section #6

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

Merged
merged 3 commits into from
Apr 13, 2024

Conversation

kevinstadler
Copy link
Contributor

@kevinstadler kevinstadler commented Sep 9, 2023

Many core libraries (such as Hardware I/O, Video and Sound) lack @instanceName annotations on their classes, which leads to misleading 'syntax' sections of their method references already noted in processing/processing-website#397 (see e.g. movieObject.available()) which only look like:

Syntax
.methodName()

Those classes which do have an explicit @instanceName annotation (such as the Serial library) use the same instance name and description for static methods, which is also misleading (e.g. in the case of Serial.list()):

Syntax
serial.list()
Parameters
serial (Serial) any variable of type Serial

This pull request sets a non-empty default instance name which is the exact class name (for static methods) or a lower case version of the class name (for instance methods). If desired it would also be possible to add a default instance description that follows the conventions of the Processing core classes or Serial library ("any object/variable of type ...")

@SableRaf
Copy link
Contributor

Hello Kevin and thanks for the detailed explanation in the pull request 🙏

@runemadsen and @fdoflorenzano, I'd appreciate your insights on this. When you have a moment, could you take a minute to review Kevin's changes and provide feedback? Thanks for your help on this!

@SableRaf SableRaf merged commit 9841420 into processing:main Apr 13, 2024
@SableRaf
Copy link
Contributor

Thanks @kevinstadler! Great job ✨ And thanks to the OSACC 2024 Processing work group for their input on the best approach to this.

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