Skip to content

Expand (and reduce) API documentation coverage #513

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

Open
adamreeve opened this issue Mar 24, 2025 · 0 comments
Open

Expand (and reduce) API documentation coverage #513

adamreeve opened this issue Mar 24, 2025 · 0 comments

Comments

@adamreeve
Copy link
Contributor

adamreeve commented Mar 24, 2025

We now have auto-generated API documentation at https://g-research.github.io/ParquetSharp/.

This issues covers reviewing the documentation and making sure all public methods are documented.

There are also some methods where we should hide documentation as they aren't intended for use by consumers. Eg. see ColumnReader.TypedColumnReader_ReadBatch_Bool for example. There are a lot of methods like this that are protected method of a public class, but the constructors are all internal so it shouldn't be possible for users to call them and they add noise to the documentation.

These can be hidden by adding an /// <exclude /> comment (see https://dotnet.github.io/docfx/docs/dotnet-api-docs.html#filter-apis)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Great Ideas
Development

No branches or pull requests

1 participant