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.

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

Conversation

carlossanlop
Copy link
Contributor

@JasonCard @gewarren @BillWagner PTAL

Fixed the issue reported by Jason, and also found a type summary that we can fix at the same time.

@carlossanlop carlossanlop self-assigned this Sep 3, 2020
- 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:

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.

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.

@opbld34
Copy link
opbld34 commented Sep 3, 2020

Docs Build status updates of commit 7d64079:

✅ Validation status: passed

File Status Preview URL Details
xml/Microsoft.Build.Globbing/MSBuildGlob.xml ✅Succeeded View
xml/System.Net.Security/SslClientHelloInfo.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld31
Copy link
opbld31 commented Sep 3, 2020

Docs Build status updates of commit c4914a2:

✅ Validation status: passed

File Status Preview URL Details
xml/Microsoft.Build.Globbing/MSBuildGlob.xml ✅Succeeded View
xml/System.Net.Security/SslClientHelloInfo.xml ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@carlossanlop carlossanlop merged commit daaf20b into dotnet:master Sep 3, 2020
@carlossanlop carlossanlop deleted the Fix branch September 3, 2020 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
0