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

API documentation debt - Microsoft.Extensions.FileSystemGlobbing #43908

Open
Tracked by #43849
carlossanlop opened this issue Oct 27, 2020 · 2 comments
Open
Tracked by #43849

API documentation debt - Microsoft.Extensions.FileSystemGlobbing #43908

carlossanlop opened this issue Oct 27, 2020 · 2 comments
Labels
area-Extensions-FileSystem documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@carlossanlop
Copy link
Member

Area owners: @maryamariyan @carlossanlop @jozkee

The APIs in the list below are missing some or all of their documentation. Please add the missing documentation directly in triple slash comments in source. We will make sure it gets ported to dotnet-api-docs after it's merged.

Make sure to follow the documentation guidelines defined in the dotnet-api-docs wiki:
https://github.com/dotnet/dotnet-api-docs/wiki

Also please add me as a PR reviewer.

Community contributions are welcome.

Microsoft.Extensions.FileSystemGlobbing
DocId Summary Parameters TypeParameters ReturnValue Source File Path Docs URL
Microsoft.Extensions.FileSystemGlobbing namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.FileSystemGlobbing.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing?branch=master
Microsoft.Extensions.FileSystemGlobbing.Abstractions namespace Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/ns-Microsoft.Extensions.FileSystemGlobbing.Abstractions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/DirectoryInfoBase.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoBase.-ctor?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.EnumerateFileSystemInfos Missing NA NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/DirectoryInfoWrapper.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.EnumerateFileSystemInfos?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetFile(System.String) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/DirectoryInfoWrapper.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.GetFile?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/FileInfoBase.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileInfoBase.-ctor?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.#ctor Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/FileSystemInfoBase.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.FileSystemInfoBase.-ctor?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.EnumerateFileSystemInfos Missing NA NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/InMemoryDirectoryInfo.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.EnumerateFileSystemInfos?branch=master
M:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetDirectory(System.String) Missing Missing NA Missing https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/InMemoryDirectoryInfo.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.GetDirectory?branch=master
P:Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.Name Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing.Abstractions/DirectoryInfoWrapper.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.Abstractions.DirectoryInfoWrapper.Name?branch=master
P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.FullName Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/InMemoryDirectoryInfo.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.FullName?branch=master
P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.Name Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/InMemoryDirectoryInfo.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.Name?branch=master
P:Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.ParentDirectory Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/InMemoryDirectoryInfo.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.InMemoryDirectoryInfo.ParentDirectory?branch=master
T:Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions Missing NA NA NA https://github.com/dotnet/dotnet-api-docs/blob/master/xml/Microsoft.Extensions.FileSystemGlobbing/MatcherExtensions.xml https://review.docs.microsoft.com/en-us/dotnet/api/Microsoft.Extensions.FileSystemGlobbing.MatcherExtensions?branch=master

Notes:

  • The namespaces need to be documented directly in dotnet-api-docs.
  • Some of the APIs are obsolete, so I'll let area owners decide if they want to still document them or skip them. If you opt for documenting them, please do it directly in dotnet-api-docs.
@carlossanlop carlossanlop added documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors untriaged New issue has not been triaged by the area owner area-Microsoft.Extensions labels Oct 27, 2020
@carlossanlop carlossanlop added this to the 6.0.0 milestone Oct 27, 2020
@maryamariyan maryamariyan added area-Extensions-FileSystem and removed area-Microsoft.Extensions untriaged New issue has not been triaged by the area owner labels Nov 5, 2020
@ghost
Copy link

ghost commented Nov 5, 2020

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

@adamsitnik adamsitnik modified the milestones: 6.0.0, 7.0.0 Jul 28, 2021
@adamsitnik
Copy link
Member

I've moved it to 7.0 as I simply don't see us having time to finish it for 6.0. Please feel free to send a PR and prove me wrong ;)

@jeffhandley jeffhandley modified the milestones: 7.0.0, 8.0.0 Aug 10, 2022
@carlossanlop carlossanlop modified the milestones: 8.0.0, 9.0.0 Oct 11, 2023
@adamsitnik adamsitnik modified the milestones: 9.0.0, Future Jul 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Extensions-FileSystem documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

No branches or pull requests

4 participants