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 fix] unclear documentation in iothub_client_sample_upload_to_blob_with_retry.c #2638

Open
bertulli opened this issue Jul 19, 2024 · 0 comments

Comments

@bertulli
Copy link

SDK Version

I'm on commit 033308b , that should refer roughly to Release LTS_03_2024_Ref02

Describe the Bug
The sample file iothub_client_sample_upload_to_blob_with_retry.c is still present in the SDK but it is undocumented. It is not advised on the README page of the samples, and it is somewhat similar to iothub_client_sample_upload_to_blob_mb.c, but in the latter there is explicitely a comment describing what the sample does:

// "block_count" is used to simulate reading chunks from a larger data content, like a large file.
// Note that the IoT SDK caller does NOT free(*data), as a typical use case the buffer returned 
// to the IoT layer may be part of a larger buffer that this callback is chunking up for network sends.

while in the former there is no indication. I read the former before, so I got confused and for instance thought the block segmentation was done automatically, thus sending to the cloud ten copies per file. I thought this may happen to other too, so I thought it could beneficial to insert a note in the documentation or the file, or simply deleting it and keeping only the mb one.

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

1 participant