fix(svm): format docstrings #853
Open
+30
−30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Reinis Martinsons <[email protected]>
Reinis-FRP
requested review from
mrice32,
nicholaspai,
chrismaree and
md0x
as code owners
md0x
reviewed
Jan 10, 2025
| @@ -40,28 +40,28 @@ pub struct BridgeTokensToHubPool<'info> { | |||
| pub token_messenger_minter_sender_authority: UncheckedAccount<'info>, | |||
|
|
|||
| /// CHECK: MessageTransmitter is checked in CCTP. Seeds must be \["message_transmitter"\] (CCTP Message Transmitter | |||
| /// program). | |||
| // program). | |||
There was a problem hiding this comment.
Turning these into double slashes doesn't remove them from docs?
There was a problem hiding this comment.
it should remove them from the docs, aren't they?
There was a problem hiding this comment.
Okay, yes, before your change, Anchor was adding program). to the documentation.
Now, it doesn’t add documentation for this account (expected behavior).
Before your fix:
{
"name": "message_transmitter",
"docs": [
"program)."
],
"writable": true
},
After fix:
{
"name": "message_transmitter",
"writable": true
},
All good!
md0x
approved these changes
Jan 10, 2025
chrismaree
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Anchor IDL generates docs from lines starting with tripple-slashes (
///). Some of comments had these unnecessarily causing the IDL docs including information that is not specific to a given instruction or account. This fixes by formatting these lines as regular comments starting with double-slash (//).