8000 Fix double asterisk, add extra type summary by carlossanlop · Pull Request #4787 · dotnet/dotnet-api-docs · GitHub
[go: up one dir, main page]
Skip to content

Fix double asterisk, add extra type summary #4787

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
merged 2 commits into from
Sep 3, 2020
Merged

Fix double asterisk, add extra type summary #4787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d64079
Fix double asterisk, add extra type summary
carlossanlop Sep 3, 2020
c4914a2
Update xml/Microsoft.Build.Globbing/MSBuildGlob.xml
carlossanlop Sep 3, 2020
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
6 changes: 3 additions & 3 deletions xml/Microsoft.Build.Globbing/MSBuildGlob.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
<summary>
Represents a parsed MSBuild glob.
An MSBuild glob is composed of three parts:
- fixed directory part: "a/b/" in "a/b/**/*test*/**/*.cs"
- wildcard directory part: "**/*test*/**/" in "a/b/**/*test*/**/*.cs"
- file name part: "*.cs" in "a/b/**/*test*/**/*.cs"
- fixed directory part: <c>a/b/</c> in <c>a/b/\*\*/*test\*/\*\*/\*.cs</c>
- wildcard directory part: <c>\*\*/\*test\*/\*\*/</c> in <c>a/b/\*\*/\*test\*/\*\*/\*.cs</c>
- file name part: <c>\*.cs</c> in <c>a/b/\*\*/\*test\*/\*\*/\*.cs</c>
</summary>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not markdown, so I don't know why the double star is being interpreted as bold. @joelmartinez do you know if my fix is correct so the star characters show up?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm ... Admittedly, I too was under the impression that summary content was not treated as markdown, however inspecting the code for Ecma2Yaml, I can find this (for overloads), which shows that it's handling the summary in this case as markdown. This means the fix you've added here is required from an authoring perspective.
https://github.com/docascode/ECMA2Yaml/blob/49078f3b9d9be2c6d034b089ecffd213bd7e5ab1/ECMA2Yaml/ECMA2Yaml/YamlHelpers/YamlHeaderWriter.cs#L17-L20

    [JsonProperty("summary")]
    [MarkdownContent]
    [YamlMember(Alias = "summary")]
    public string Summary { get; set; }

@TianqiZhang, can you verify whether the summary is treated in ecma2yaml as markdown across the board?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found an existing example that works well:

dotnet-api-docs/xml/Microsoft.Extensions.FileProviders/PhysicalFileProvider.xml

Line 370 in 09f58cd

Filter string used to determine what files or folders to monitor. Examples: <c>\*\*/\*.cs</c>, <c>\*.\*</c>, <c>subfolder/\*\*/\*.cshtml</c>.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's how that one looks: https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.fileproviders.physicalfileprovider.watch?view=dotnet-plat-ext-3.1#parameters

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirmed that example had no issues for loc, so this fix should work.

<remarks>To be added.</remarks>
</Docs>
Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net.Security/SslClientHelloInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
</Attribute>
</Attributes>
<Docs>
<summary>To be added.</summary>
<summary>This struct contains information from received TLS Client Hello frame.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand Down
0