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

Incorrect information about device function ARGS #1109

Open
sethherr opened this issue Jul 21, 2020 · 1 comment
Open

Incorrect information about device function ARGS #1109

sethherr opened this issue Jul 21, 2020 · 1 comment

Comments

@sethherr
Copy link

TL;DR update the Cloud API docs with the function argument information from the Device OS API Docs.

In call a function on the Cloud API docs the information about the ARG parameter reads:

Function argument with a maximum length of 63 characters

Screen Shot 2020-07-21 at 12 03 47 PM

In the Device OS API Docs (e.g. Argon Particle.function) it has different information:

A cloud function is set up to take one argument of the String datatype. This argument length is limited to a max of 63 characters (prior to 0.8.0), 622 characters (since 0.8.0). The String is UTF-8 encoded.

Screen Shot 2020-07-21 at 12 05 52 PM

The arg parameter does appear to be limited to 622 characters now - which is great!

p.s. I would've submitted a PR to fix this, but it doesn't appear to be possible, I couldn't find the text in the repository.

@rickkas7
Copy link
Contributor

Thanks for the feedback. You are correct and the string doesn't exist in the docs repository because it's auto-generated from comments in the source, so it has to be changed there.

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

No branches or pull requests

2 participants