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

Merged
merged 6 commits into from
Sep 25, 2024
Merged

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?

@gewarren gewarren merged commit 3baa42e into dotnet:main Sep 25, 2024
83 of 85 checks passed
@gewarren gewarren deleted the docs0913 branch September 25, 2024 16:39
@gewarren
Copy link
Contributor Author

@carlossanlop Can you backport this one please?

@carlossanlop
Copy link
Member

/backport to release/9.0

Copy link
Contributor

Started backporting to release/9.0: https://github.com/dotnet/runtime/actions/runs/11041750136

Copy link
Contributor

@carlossanlop backporting to release/9.0 failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: doc updates
Using index info to reconstruct a base tree...
M	src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs
M	src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs
M	src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs
M	src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs
M	src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs
M	src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs
Falling back to patching base and 3-way merge...
Auto-merging src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs
CONFLICT (content): Merge conflict in src/libraries/Microsoft.Extensions.Primitives/src/StringValues.cs
Auto-merging src/libraries/Microsoft.Extensions.Hosting/src/HostingHostBuilderExtensions.cs
Auto-merging src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFilesWatcher.cs
Auto-merging src/libraries/Microsoft.Extensions.FileProviders.Physical/src/PhysicalFileProvider.cs
Auto-merging src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs
CONFLICT (content): Merge conflict in src/libraries/Microsoft.Extensions.FileProviders.Composite/src/CompositeFileProvider.cs
Auto-merging src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs
CONFLICT (content): Merge conflict in src/libraries/Microsoft.Extensions.FileProviders.Abstractions/src/IFileProvider.cs
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 doc updates
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

Copy link
Contributor

@carlossanlop an error occurred while backporting to release/9.0, please check the run log for details!

Error: git am failed, most likely due to a merge conflict.

carlossanlop pushed a commit to carlossanlop/runtime that referenced this pull request Sep 25, 2024
carlossanlop added a commit that referenced this pull request Sep 26, 2024
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
sirntar pushed a commit to sirntar/runtime that referenced this pull request Sep 30, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 26, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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