search

fredeil / email-validator.dart

A simple Dart class for validating email addresses (syntax) without using RegEx :email:
https://pub.dartlang.org/packages/email_validator
MIT License
195 stars 38 forks source link

[Help wanted] Improve documentation pub.dev score #36

Closed fredeil closed 2 years ago

fredeil commented 2 years ago

Should be a low hanging fruit for anyone interested in contributing to the repository 😄

image

fredeil commented 2 years ago

I'm not sure if this issue is totally relevant.

See https://github.com/dart-lang/pub-dev/issues/5285 for clarifications eventually

fredeil commented 2 years ago

See https://github.com/dart-lang/pub-dev/issues/5285#issuecomment-975464728 on how to go on to solve this issue.

Thanks for reporting the issue. I'll mark this as a duplicate of #5194.

For your specific case, at first glance, you have multiple things in the API surface which we should mention in the report:

  • a library (which may have a documentation)
  • a public class with a public constructor (these may have separate documentation)
  • a public enum (type) with 4 values + extra method, all without documentation.

If you were to limit your API surface, I think the wrapper class is not really useful (especially as the single public method is static), and the enum could be potentially be private too.

One takeaway for the scoring is that if a package has a single library, we should not count that here, as it becomes important if you have multiple top-level libraries.

maxzod commented 2 years ago

this should be close now 😄 image

fredeil commented 2 years ago

Yeah, they seem to have made some changes on the pub-dev website @maxzod. I'll close it for now, thanks!