Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.

CloudBlobClient.GetRootContainerReference XmlDoc is not correctly formatted #928

Closed
Chris-Johnston opened this issue Aug 27, 2019 · 1 comment · May be fixed by #941
Closed

CloudBlobClient.GetRootContainerReference XmlDoc is not correctly formatted #928

Chris-Johnston opened this issue Aug 27, 2019 · 1 comment · May be fixed by #941
Labels
bug

Comments

@Chris-Johnston
Copy link

azure-storage-net/Lib/Common/Blob/CloudBlobClient.Common.cs

Lines 190 to 191 in bbb7da6

/// <remarks>Note that the root container must be explicitly created, if it does not already exist, before
/// you can read from it or write to it.</remarks>

The formatting of the Remarks field for this method appears to be incorrectly formatted, as seen in the docs. Maybe the xmldoc comments don't like the newline? I haven't seen this issue before myself.
Chris-Johnston added a commit to Chris-Johnston/azure-storage-net that referenced this issue Oct 4, 2019
@Chris-Johnston
Fix Azure#928 Fix formatting of GetRootContainerReference xmldoc remarks
7a75d11 
This change fixes the formatting of the `<remarks>` field of the xmldoc for CloudBlobClient.GetRootContainerReference. It appears fine when reading the source code, but on docs.microsoft.com, the second line appears indented. I think this may be because of the newline in this block.
This newline in this block has been removed. There are other LOC in this file that are around or above the character count per line, if keeping a consistent ruler is an issue.
Chris-Johnston added a commit to Chris-Johnston/azure-storage-net that referenced this issue Oct 4, 2019
@Chris-Johnston
Fix Azure#928 Fix formatting of GetRootContainerReference xmldoc remarks
5cc5c40 
This change fixes the formatting of the `<remarks>` field of the xmldoc for CloudBlobClient.GetRootContainerReference. It appears fine when reading the source code, but on docs.microsoft.com, the second line appears indented. I think this may be because of the newline in this block.
This newline in this block has been removed. There are other LOC in this file that are around or above the character count per line, if keeping a consistent ruler is an issue.
@Chris-Johnston Chris-Johnston mentioned this issue Oct 4, 2019
Open
@seanmcc-msft
Copy link
Member

We'll fix this in a future release.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #928 Fix formatting of GetRootContainerReference xmldoc remarks Chris-Johnston/azure-storage-net
2 participants
@Chris-Johnston @seanmcc-msft