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

chore: Re-enable missing-docs lint #876

Merged
merged 2 commits into from
Mar 13, 2024
Merged

chore: Re-enable missing-docs lint #876

merged 2 commits into from
Mar 13, 2024

Conversation

aborgna-q
Copy link
Collaborator

#868 didn't actually enable the lints in quantinuum-hugr when the config was moved to the workspace.

@aborgna-q aborgna-q requested a review from doug-q March 12, 2024 15:12
@aborgna-q aborgna-q force-pushed the chore/re-enable-lints branch from 1424f56 to 2f92518 Compare March 12, 2024 15:19
Copy link

codecov bot commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.65%. Comparing base (46a7fba) to head (ade4527).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #876      +/-   ##
==========================================
+ Coverage   85.59%   85.65%   +0.06%     
==========================================
  Files          78       78              
  Lines       14432    14432              
  Branches    14432    14432              
==========================================
+ Hits        12353    12362       +9     
+ Misses       1442     1433       -9     
  Partials      637      637              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@doug-q
Copy link
Collaborator

doug-q commented Mar 13, 2024

I think the #[allow(missing_docs)] is dubious. I agree that the existing constructors are ok to not document their fields because they are quasi-documented via the error messages. However these annotations will apply to newly added constuctors.

perhaps adding
#[allow(missing_docs)] // all fields are mentioned in error message per-constructor would be better?

Happy to approve if you think this would be too verbose

@aborgna-q
Copy link
Collaborator Author

I wanted to avoid the boilerplate; but I agree that variants should always have docs.
I moved the attributes to the variants (without the comment though, as that's even more verbose).

@aborgna-q aborgna-q added this pull request to the merge queue Mar 13, 2024
Merged via the queue into main with commit db1d11c Mar 13, 2024
10 checks passed
@aborgna-q aborgna-q deleted the chore/re-enable-lints branch March 13, 2024 16:12
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