Skip to content
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

More doc updates for source-of-truth assemblies #107810

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

gewarren
Copy link
Contributor

Contributes to dotnet/dotnet-api-docs#9989.

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Reviewed half of the files, until Microsoft.Extensions.FileProviders.

Next review starts at Microsoft.Extensions.Hosting.

@carlossanlop carlossanlop added area-Extensions-FileSystem area-Meta documentation Documentation bug or enhancement, does not impact product or test code and removed area-Extensions-Logging area-Extensions-FileSystem labels Sep 13, 2024
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

1 similar comment
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Copy link
Member

@carlossanlop carlossanlop left a comment

Choose a reason for hiding this comment

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

Left some comments for you to consider, otherwise it LGTM.
I'll backport this to release/9.0 as well when you merge it.

/// </summary>
public string? SourceName { get; set; }

/// <summary>
/// Name of the machine having the event log. If <c>null</c> or not specified, local machine is the default.
/// Gets or sets the name of the machine with the event log. If <see langword="null" /> or not specified, local machine is the default.
Copy link
Member

Choose a reason for hiding this comment

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

For consistency with the others:

Suggested change
/// Gets or sets the name of the machine with the event log. If <see langword="null" /> or not specified, local machine is the default.
/// Gets or sets the name of the machine with the event log. If <see langword="null" /> or not specified, "local machine" is the default.

@dotnet/area-extensions-logging does this default value begin in lowercase?

@carlossanlop
Copy link
Member

It would be nice to backport this to 9.0. Today's the snap for the RC2 branch but we still have time tomorrow before we start the builds. Would you mind looking at the feedback when you get a chance @gewarren?

Co-authored-by: Carlos Sánchez López <1175054+carlossanlop@users.noreply.github.com>
@gewarren
Copy link
Contributor Author

@carlossanlop There seem to be a lot of errors. Is this okay to merge?

@@ -426,8 +426,8 @@ private void GenLogMethod(LoggerMethod lm, string nestedIndentation)
{nestedIndentation}{enabledCheckIndentation}{level},
{nestedIndentation}{enabledCheckIndentation}new global::Microsoft.Extensions.Logging.EventId({lm.EventId}, {eventName}),
{nestedIndentation}{enabledCheckIndentation}");
GenHolder(lm);
_builder.Append($@",
GenHolder(lm);
Copy link
Member

Choose a reason for hiding this comment

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

@dotnet/area-extensions-logging do you know if the CI failures might be related to changes to the gen files in this PR? Some of the failures say that lines do not match, but I don't know enough to determine if we need to avoid changes in such files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Meta documentation Documentation bug or enhancement, does not impact product or test code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants