[Storage] improving documentation#16945
[Storage] improving documentation#16945seankane-msft merged 24 commits intoAzure:mohsha-msft/fix-listing-metadata-parsingfrom
Conversation
ghost
added
the
|
In general, throughout the examples some comments were removed without a replacement. A lot of them were cases like the comments for setting the account information, which may seem redundant/unnecessary after a while, but if people are only looking at one example at a time, it's probably best to just keep them. Are there reasons we would want to remove some comments completely or is it more likely an oversight? |
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
@kimprice my goal was to remove excess comments from code on portions that I thought were obvious. I think that's a conversation we should take offline to discuss what knowledge we expect doc readers to already have and which is same to assume they have. |
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
seankane-msft
changed the base branch from
main
to
mohsha-msft/fix-listing-metadata-parsing
|
This pull request is protected by Check Enforcer. What is Check Enforcer?Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass. Why am I getting this message?You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged. What should I do now?If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows: What if I am onboarding a new service?Often, new services do not have validation pipelines associated with them. In order to bootstrap pipelines for a new service, please perform following steps: For track 2 SDKs Issue the following command as a pull request comment:
|
|
/check-enforcer reset |
* Manual fixes in generated models to adapt azcore 0.21 * Fix SAS Creation + other issue (#16901) * Fix SAS Creation + other issue * Added README.md + Fix comment * Removed Specification File. * Updated CHANGELOG * Regenerated Recordings + Ran Live Tests (#16990) * [Storage] convert options to take pointer (#16978) * convert to nil * changelog entry * adding a comment about nil, changing o to options for better clarity * Bumped up AzCore to the latest version * azblob: fix ListBlob to preserve prefix while paging (#16992) * [Storage] improving documentation (#16945) * improving documentation * updating changelog * ctx -> context.TODO(), simplifying comments * updating a few more examples * improving docs further * Update sdk/storage/azblob/zt_examples_test.go Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Update sdk/storage/azblob/zt_examples_test.go Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Update sdk/storage/azblob/zt_examples_test.go Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Update sdk/storage/azblob/zt_examples_test.go Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Update sdk/storage/azblob/zt_examples_test.go Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * finished doc updates * Background -> TODO * valid container name * updating readme * Update sdk/storage/azblob/README.md Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Update sdk/storage/azblob/README.md Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * removing todos * more comments and additions * set env vars with bash * Azure Storage Blob -> Azure Blob Storage * Update CHANGELOG.md * forcing a change Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com> * Added Release Date in CHANGELOG. Co-authored-by: Sean Kane <68240067+seankane-msft@users.noreply.github.com> Co-authored-by: Philip Dubé <serprex@users.noreply.github.com> Co-authored-by: Kim Ying <15070078+kimprice@users.noreply.github.com>
3 participants
Improving documentation for
pkg.go.devviewers