question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Missing examples and spelling issues

See original GitHub issue

The main page for the BlobUploadOptions class has a misspelling of “paratmers” for parameters. It is also lacking in examples of usage. From the documentation it is not clear how to specify the Content Type of the uploaded blob. After digging into the various options I was able to determine that it is set via the HttpHeaders property. It would be nice to have a few examples in the BlobUploadOptions documentation for common use scenarios, such as: var opts = new BlobUploadOptions(); { HttpHeaders = new BlobHttpHeaders() { ContentType = "application/octet-stream" } };

Having additional examples for using the Metadata property would also greatly improve the documentation. Thanks!


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
navba-MSFTcommented, Mar 4, 2022

@Kellybnd Apologies for the late reply. Thanks for the feedback. The above PR has been created and it is currently under review. In the meantime, if you have any questions on this, please let us know.

0reactions
Kellybndcommented, Feb 2, 2021

Hi @amnguye,

I’d suggest that examples simply cover some of the common scenarios. For instance, the blob storage documentation for managing blob properties and metadata contains examples for setting the ContentType and ContentLanguage https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blob-properties-metadata?tabs=dotnet. Both of these properties can be set using BlobUploadOptions while uploading. I don’t think you need to have an example for every available parameter, but certainly the ones that cover common use cases would be helpful. Having no examples at all, along with minimal descriptions make the API much more difficult to use.

Thanks!

Read more comments on GitHub >

github_iconTop Results From Across the Web

3 Causes of spelling difficulties in children and adults
Dyslexia, ADHD/ADD and hearing impairment are common causes of spelling difficulties. Learn more about them and how you can help.
Read more >
What Causes Problems with Spelling?
Problems with spelling can lead to poor performance at school. ... It is also the ability to fill in the missing piece of...
Read more >
Spelling and Dyslexia
What causes spelling problems? ... One common but mistaken belief is that spelling problems stem from a poor visual memory for the sequences...
Read more >
The 32 most commonly misspelled words that make you ...
1. accommodate · : acommodate, accomodate ; 2. acknowledgment · : acknowledgement ; 3. acquire · : aquire ; 4. apparent · :...
Read more >
Causes of Trouble With Spelling
The spelling connection: People with dysgraphia have trouble getting words on paper, either by handwriting or typing them. They may have a hard...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found