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.

Sign up for GitHub

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

Jump to bottom

fix_6/#90 - added comments to classes and methods in folder "utils" #179

Merged
merged 1 commit into from
Jul 13, 2021
Merged

fix_6/#90 - added comments to classes and methods in folder "utils" #179

merged 1 commit into from
Jul 13, 2021

Conversation

monsieurtanuki
Copy link
Contributor

There are still classes to add comments to in this folder, but this is a quick PR.

Impacted files:

  • ImageHelper.dart
  • JsonHelper.dart
  • LanguageHelper.dart
  • NutrimentsHelper.dart
  • PnnsGroupQueryConfiguration.dart
  • PnnsGroups.dart
  • ProductFields.dart
  • ProductHelper.dart
  • QueryType.dart
  • UnitHelper.dart

@monsieurtanuki
fix_6/openfoodfacts#90 - added comments to classes and methods in fol…
3ddca92 
…der "utils"

There are still classes to add comments to in this folder, but this is a quick PR.

Impacted files:
* `ImageHelper.dart`
* `JsonHelper.dart`
* `LanguageHelper.dart`
* `NutrimentsHelper.dart`
* `PnnsGroupQueryConfiguration.dart`
* `PnnsGroups.dart`
* `ProductFields.dart`
* `ProductHelper.dart`
* `QueryType.dart`
* `UnitHelper.dart`
peterwvj
peterwvj approved these changes Jul 13, 2021
View reviewed changes
Copy link
Collaborator

@peterwvj peterwvj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thanks!

@monsieurtanuki monsieurtanuki merged commit b8f0693 into openfoodfacts:master Jul 13, 2021
@monsieurtanuki
Copy link
Contributor Author

Very busy today, don't know why! :)
Thank you @peterwvj @M123-dev @MohamedFBoussaid for your code reviews and comments in the last 2 days.

@M123-dev
Copy link
Member

@monsieurtanuki. it has a good purpose. A 130 score would be awesome

@monsieurtanuki
Copy link
Contributor Author

@M123-dev Sure! The problem is that I could not find a way to pre-compute how good we are for the comments. There's a threshold of 20% of comments (cf. https://pub.dev/packages/openfoodfacts/score):

0/10 points: 20% or more of the public API has dartdoc comments
80 out of 1786 API elements (4.5 %) have documentation comments.

The idea now is to systematically add dart comments for new classes and methods.
And to add comments once in a while for older code.
By the time we upload to pub.dev maybe we'll go beyond the 20% barrier and get the last 10 points!

@monsieurtanuki monsieurtanuki deleted the fix_6/#90 branch September 17, 2021 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peterwvj peterwvj peterwvj approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@monsieurtanuki @M123-dev @peterwvj