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.

Sign up for GitHub

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

Jump to bottom

Functions returning waves should document when they return an input wave #43

Open
t-b opened this issue Jan 23, 2025 · 0 comments
Open

Functions returning waves should document when they return an input wave #43

t-b opened this issue Jan 23, 2025 · 0 comments

Comments

@t-b
Copy link
Member

t-b commented Jan 23, 2025 •
edited
Loading

Callers of functions like

Function/WAVE wrangleData(WAVE input)
   // ...

   return output
End

nearly always assume that the returned data is not the same wave ref as input. i.e. they are free to modify output without changing input.

If functions do something like that they need to document that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@t-b