chore(protocol): cleanup autogen docs #14451
Conversation
| @@ -431,7 +434,10 @@ contract ProverPool is EssentialContract, IProverPool { | |||
| return true; | |||
| } | |||
|
|
|||
| // Calculates the user weight's when it stakes/unstakes/slashed | |||
| /// @dev See the documentation for the callers of this internal function. | |||
There was a problem hiding this comment.
Here in this doc, we used /** **/ and ///, shall we stick to one format across all files?
| * system. It defines methods for sending and verifying signals with merkle | ||
| * proofs. The trust assumption is that the target chain has secure access | ||
| * to the merkle root (such as Taiko injects it in the anchor transaction). | ||
| * With this, verifying a signal is reduced to simply verifying a merkle proof. |
There was a problem hiding this comment.
will put @title as the first line better?
There was a problem hiding this comment.
overall, i agree with this. in fact, there are two changes i want to make:
- @title before description
- verbosely include "@notice" even though it is not required by solidity compiler
- move multi-line comment blocks to
///instead of/** */for simplicity
however, i would like to introduce that later, after we cleanup the bridge documentation as well and get consistency throughout the codebase. i already commented the bridge/signal service previously using the standards here: https://taiko.xyz/docs/manuals/contributing-manual#source-code-comments
so don't want to bikeshed over this. once we document to the spec, we can update the spec and use chatGPT to fixup all the files quickly.
I removed the 3 TODOs |
dionysuzx
force-pushed
the
cleanup-better-proto-docs
branch
from
69a17d6 to
ac01d84
Compare
|
closing this PR in favor of #14462 |
@dantaik @adaki2004 I reviewed each file in the previous PR and applied a consistent standard. Could you please:
TODO(docs)that I leftI will merge this PR after review.