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

Code comments to resolve Javadoc errors #1346

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

awatson1978
Copy link
Collaborator

This PR is related to discussion item #1345. Need to evaluate if this level of code commenting is appropriate, or whether we need to relax linting rules.

@sonatype-lift
Copy link
Contributor

sonatype-lift bot commented Aug 3, 2023

Sonatype Lift is retiring

Sonatype Lift will be retiring on Sep 12, 2023, with its analysis stopping on Aug 12, 2023. We understand that this news may come as a disappointment, and Sonatype is committed to helping you transition off it seamlessly. If you’d like to retain your data, please export your issues from the web console.
We are extremely grateful and thank you for your support over the years.

📖 Read about the impacts and timeline

@awatson1978 awatson1978 marked this pull request as draft August 3, 2023 01:58
@codecov
Copy link

codecov bot commented Aug 3, 2023

Codecov Report

Merging #1346 (d233d22) into master (9f7c6cc) will decrease coverage by 1%.
Report is 3 commits behind head on master.
The diff coverage is n/a.

@@           Coverage Diff            @@
##             master   #1346   +/-   ##
========================================
- Coverage        77%     77%   -1%     
+ Complexity     3728    3725    -3     
========================================
  Files           170     170           
  Lines         23981   23981           
  Branches       3325    3325           
========================================
- Hits          18654   18652    -2     
- Misses         4314    4315    +1     
- Partials       1013    1014    +1     
Files Changed Coverage Δ
.../org/mitre/synthea/export/rif/BB2RIFStructure.java 99% <ø> (ø)

... and 17 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@dehall
Copy link
Contributor

dehall commented Aug 18, 2023

My vote is that comments like these where it's just a rehash of the code (or in this case, the code itself verbatim) are not useful, and in fact have negative value because now you have neither a meaningful comment nor a warning that says "you need to have comments".
Ideally we'd have real comments describing the what and/or why of everything but I realize that's a nontrivial effort. Maybe there's a flag we can use to disable that linter on a given field such as these BB enums? Loosening the restrictions on comments globally sounds like admitting defeat

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

Successfully merging this pull request may close these issues.

2 participants