Skip to content

docstring fixes for Upload() and UploadAsync() #22281

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.

Sign up for GitHub

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

Merged
jaschrep-msft merged 2 commits into from
Jun 29, 2021
Merged

docstring fixes for Upload() and UploadAsync() #22281

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b26b2
docstring fixes for Upload() and UploadAsync()
jaschrep-msft Jun 29, 2021
16b90ed
fully qualified reference to BlockBlobClient
jaschrep-msft Jun 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 29 additions & 29 deletions sdk/storage/Azure.Storage.Blobs/src/BlobClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ protected internal virtual BlobClient WithClientSideEncryptionOptionsCore(Client
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand All @@ -346,7 +346,7 @@ public virtual Response<BlobContentInfo> Upload(Stream content) =>
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand All @@ -373,7 +373,7 @@ public virtual Response<BlobContentInfo> Upload(BinaryData content) =>
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -401,7 +401,7 @@ public virtual Response<BlobContentInfo> Upload(string path) =>
/// existing block blob overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -429,7 +429,7 @@ public virtual async Task<Response<BlobContentInfo>> UploadAsync(Stream content)
/// existing block blob overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand All @@ -456,7 +456,7 @@ public virtual async Task<Response<BlobContentInfo>> UploadAsync(BinaryData cont
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand All @@ -483,7 +483,7 @@ public virtual async Task<Response<BlobContentInfo>> UploadAsync(string path) =>
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -519,7 +519,7 @@ public virtual Response<BlobContentInfo> Upload(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -555,7 +555,7 @@ public virtual Response<BlobContentInfo> Upload(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -591,7 +591,7 @@ public virtual Response<BlobContentInfo> Upload(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -627,7 +627,7 @@ public virtual Task<Response<BlobContentInfo>> UploadAsync(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -663,7 +663,7 @@ public virtual Task<Response<BlobContentInfo>> UploadAsync(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -700,7 +700,7 @@ await UploadAsync(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -744,7 +744,7 @@ public virtual Response<BlobContentInfo> Upload(
/// overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -785,7 +785,7 @@ public virtual Response<BlobContentInfo> Upload(
/// creates a new block blob or throws if the blob already exists.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -829,7 +829,7 @@ public virtual Response<BlobContentInfo> Upload(
/// overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -873,7 +873,7 @@ public virtual Task<Response<BlobContentInfo>> UploadAsync(
/// overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -917,7 +917,7 @@ public virtual Task<Response<BlobContentInfo>> UploadAsync(
/// overwrites any existing metadata on the blob.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -965,7 +965,7 @@ await UploadAsync(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1013,7 +1013,7 @@ public virtual Response<BlobContentInfo> Upload(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1061,7 +1061,7 @@ public virtual Response<BlobContentInfo> Upload(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1143,7 +1143,7 @@ public virtual Response<BlobContentInfo> Upload(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1196,7 +1196,7 @@ public virtual Response<BlobContentInfo> Upload(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1273,7 +1273,7 @@ public virtual Response<BlobContentInfo> Upload(
}

/// <summary>
/// The <see cref="UploadAsync(Stream, BlobHttpHeaders, Metadata, BlobRequestConditions, IProgress{long}, AccessTier?, StorageTransferOptions, CancellationToken)"/>
/// The <see cref="UploadAsync(Stream, BlobUploadOptions, CancellationToken)"/>
/// operation overwrites the contents of the blob, creating a new block
/// blob if none exists. Overwriting an existing block blob replaces
/// any existing metadata on the blob.
Expand All @@ -1283,7 +1283,7 @@ public virtual Response<BlobContentInfo> Upload(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1331,7 +1331,7 @@ await StagedUploadInternal(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1379,7 +1379,7 @@ await StagedUploadInternal(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1461,7 +1461,7 @@ public virtual Task<Response<BlobContentInfo>> UploadAsync(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down Expand Up @@ -1514,7 +1514,7 @@ public virtual async Task<Response<BlobContentInfo>> UploadAsync(
/// to avoid overwriting existing data.
///
/// For partial block blob updates and other advanced features, please
/// see <see cref="BlockBlobClient"/>. To create or modify page or
/// see <see cref="Azure.Storage.Blobs.Specialized.BlockBlobClient"/>. To create or modify page or
/// append blobs, please see <see cref="PageBlobClient"/> or
/// <see cref="AppendBlobClient"/>.
///
Expand Down