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

Lovely, simple package, but still needs documetation #11

Closed
Zabadam opened this issue Apr 4, 2021 · 0 comments
Closed

Lovely, simple package, but still needs documetation #11

Zabadam opened this issue Apr 4, 2021 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Zabadam
Copy link

Zabadam commented Apr 4, 2021

Provide documentation 10 / 20

10/10 points: Package has an example

  • Found example at: example/main.dart

0/10 points: 20% or more of the public API has dartdoc comments

  • 3 out of 58 API elements (5.2 %) have documentation comments.
  • Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API. Document at least 20% of the public API elements.
@MichaelCharles MichaelCharles added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants