spaceandtimelabs / sxt-proof-of-sql

Space and Time | Proof of SQL

Other

1.48k stars 47 forks source link

Enable `clippy::missing_panics_doc` #163

Open JayWhite2357 opened 1 week ago

JayWhite2357 commented 1 week ago

Background and Motivation

In order to improve documentation and identify possible panics, we should enable clippy lints that warn when a function that panics but does not document this behavior.

Requested Changes

[ ] Enable clippy::missing_panics_doc lint.
[ ] Add #![cfg_attr(test, allow(clippy::missing_panics_doc))] in order to not warn on test-only functions.
[ ] Add documentation for every function violating this lint. (At the time of writing, this is 43 functions.)
[ ] Set the check-private-items = true option.
[ ] Add documentation for the private items violating this lint. (At the time of writing, this is 73 additional functions.)

It is ok for this to be done in separate PRs. (e.g. one PR could enable the lint, and simply write TODO: add panic docs everywhere the warning appears. NOTE: allow(clippy::missing_panics_doc) should only be used if a panic is actually impossible.

algora-pbc[bot] commented 4 days ago

💎 $200 bounty • Space and Time

Steps to solve:

Start working: (Optional) Comment /attempt #163 with your implementation plan. Note: we will only assign an issue if you include an implementation plan with a time estimate. Additionally, to be assigned an issue, you must have previously contributed to the project. You can still work on an issue and submit a PR without being assigned.
Submit work: Create a pull request including /claim #163 in the PR body to claim the bounty
Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to spaceandtimelabs/sxt-proof-of-sql!

Add a bounty • Share on socials

Attempt	Started (GMT+0)	Solution
🟢 @onyedikachi-david	Sep 26, 2024, 4:00:19 AM	WIP
🟢 @Gmin2		#188

onyedikachi-david commented 3 days ago

/attempt #163

Algora profile	Completed bounties	Tech	Active attempts	Options
@onyedikachi-david	7 bounties from 4 projects	JavaScript, Shell		Cancel attempt

Gmin2 commented 3 days ago

can i get assigned to this @JayWhite2357 ?

JayWhite2357 commented 3 days ago

@Gmin2 Yes. Can you please include an implementation plan with a time estimate?

FYI: to avoid confusion on this. It looks like there is a mismatch between my original GitHub comment and the adjusted bounty amount. I just deleted the GitHub comment.

EDIT: looks like that doesn't work very well.

Gmin2 commented 3 days ago

doing it by eod !

JayWhite2357 commented 3 days ago

/bounty $200

algora-pbc[bot] commented 3 days ago

💡 @Gmin2 submitted a pull request that claims the bounty. You can visit your bounty board to reward.