Skip to content

Public API document doesn't reflect the actual type of parameter #8219

Open
dotnet/runtime
#57485
@gaufung

Description

@gaufung

This bunch of public APIs first parameter is LoggerFilterOptions instead of the ILoggingBuilder . And the return type is LoggerFilterOptions instead of ILoggingBuilder as well.

Suggestion

-  /// <param name="builder">The <see cref="ILoggingBuilder"/> to add the filter to.</param>
+ /// <param name="builder">The <see cref="LoggerFilterOptions"/> to add the filter to.</param>

- /// <returns>The <see cref="ILoggingBuilder"/> so that additional calls can be chained.</returns>
+ /// <returns>The <see cref="LoggerFilterOptions"/> so that additional calls can be chained.</returns>

Activity

ghost added
untriagedNew issue has not been triaged by the area owner
on Aug 16, 2021
ghost

ghost commented on Aug 16, 2021

@ghost

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

Issue Details

This bunch of public APIs first parameter is LoggerFilterOptions instead of the ILoggingBuilder .

Suggestion

-  /// <param name="builder">The <see cref="ILoggingBuilder"/> to add the filter to.</param>
+ /// <param name="builder">The <see cref="LoggerFilterOptions"/> to add the filter to.</param>
Author: gaufung
Assignees: -
Labels:

untriaged, area-Extensions-Logging

Milestone: -
added and removed
untriagedNew issue has not been triaged by the area owner
on Aug 16, 2021
ericstj

ericstj commented on Aug 17, 2021

@ericstj
Member

@carlossanlop @maryamariyan do we need to do anything special to ensure this gets updated here too?

<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" /> to add the filter to.</param>

carlossanlop

carlossanlop commented on Aug 17, 2021

@carlossanlop
Contributor

The DocsPortingTool can't port API docs to elements that are already documented, so they need to get updated manually in the dotnet-api-docs xml.

maryamariyan

maryamariyan commented on Aug 17, 2021

@maryamariyan
Contributor

Thanks @carlossanlop

@gaufung would you be open to contributing over

<param name="builder">The <see cref="T:Microsoft.Extensions.Logging.ILoggingBuilder" /> to add the filter to.</param>
on the dotnet/dotnet-api-docs repo to submit this edit over there?

ericstj

ericstj commented on Sep 29, 2021

@ericstj
Member

I think this missed the cut-off for 6.0 docs, moving to 7.0. @carlossanlop, suppose we just flip this library to have it's source as the source-of-truth for docs, would we sill need to port anything?

added
Pri3Indicates issues/PRs that are low priority
on Jul 14, 2022
transferred this issue fromdotnet/runtimeon Jul 14, 2022

2 remaining items

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @carlossanlop@maryamariyan@ericstj@gaufung@PRMerger16

      Issue actions

        Public API document doesn't reflect the actual type of parameter · Issue #8219 · dotnet/dotnet-api-docs