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

struct module minor documentation fix #3306

Merged
merged 1 commit into from
Oct 4, 2020
Merged

Conversation

vsky279
Copy link
Contributor

@vsky279 vsky279 commented Oct 4, 2020

Fixes - no reported issue.

  • This PR is for the dev branch rather than for master.
  • This PR is compliant with the other contributing guidelines as well (if not, please describe why).
  • I have thoroughly tested my contribution.
  • The code changes are reflected in the documentation at docs/*.

Precises documentation of the struct module.

 ## struct.unpack()
 
 Returns the values packed in string `s` according to the format
-string `fmt`. An optional `i` marks where in `s` to start reading
+string `fmt`. An optional `offset` marks where in `s` to start reading
 (default is 1). After the read values, this function also returns
 the index in `s` where it stopped reading, which is also where you
 should start to read the rest of the string.

 #### Syntax

 `struct.unpack (fmt, s[, offset])`
 
 #### Returns
 
-All the unpacked data.
+All the unpacked data and index in `s` where it stoppped reading.

@pjsg pjsg merged commit 54e8696 into nodemcu:dev Oct 4, 2020
@marcelstoer marcelstoer added this to the Next release milestone Oct 5, 2020
@vsky279 vsky279 deleted the c_structdocupdate branch October 5, 2020 20:39
marcelstoer pushed a commit that referenced this pull request Nov 7, 2020
vsky279 added a commit to vsky279/nodemcu-firmware that referenced this pull request Nov 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants