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

Parse and report better on default (and potentially omitted) constructors on the documentation coverage report. #1300

Open
isoos opened this issue Dec 18, 2023 · 0 comments
Labels
type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)

Comments

@isoos
Copy link
Collaborator

isoos commented Dec 18, 2023

With #1298 we underreport the issues by omitting missing documentation on default constructors that may be called by users. We should parse the sources better and understand what a client of the package may be able to call, and require documentation on such items (or provide default documentation when such API symbol is absent from the code).

@isoos isoos added the type-bug Incorrect behavior (everything from a crash to more subtle misbehavior) label Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type-bug Incorrect behavior (everything from a crash to more subtle misbehavior)
Projects
None yet
Development

No branches or pull requests

1 participant