support parsing of docs parameter in account, argument, field directives #69
+114
−8
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.
Problem
A
docsattribute (akin to Anchor'sdesc) is not handled by the rust attribute parsing, resulting in no account doc comments in generated JS clients.Solution
Added support for an optional
docsparameter in the#[codama(account(...))]directive. The parameter accepts a string that gets converted to thedocsarray field onInstructionAccountNode.Example usage:
#[codama(account(name = "stake", writable, docs = "The stake account to operate on"))]Alternatives considered
descwas considered, since Anchor uses this in its IDLs. However, the codama codebase already expresses a preference for this to be an array of strings nameddocs./// doc commentstypically used for instruction definitions was considered, but this is brittle.