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

[DocGen] Resource function comments not being fully generated #41

Open
alilloig opened this issue Nov 21, 2022 · 1 comment
Open

[DocGen] Resource function comments not being fully generated #41

alilloig opened this issue Nov 21, 2022 · 1 comment
Assignees
Labels
Bug The issue represents a bug, malfunction, regression Feedback Good First Issue

Comments

@alilloig
Copy link
Member

Issue to be solved

At a resource that has more than one function, the comments for the second and further functions are not fully generated (they do not include the description and the param/return section)

e.g.:
source code -> https://github.com/onflow/flow-nft/blob/f8d716eb98c8d8eee1f45efb3eeaf01831312192/contracts/NonFungibleToken.cdc#L163
generated doc -> https://github.com/onflow/flow-nft/blob/default-implenentations/docs/NonFungibleToken/NonFungibleToken_Collection.md

@alilloig alilloig added Bug The issue represents a bug, malfunction, regression Feedback labels Nov 21, 2022
@turbolent
Copy link
Member

This should be fixed by onflow/cadence#2302 and onflow/cadence#2303.

TODO: verify once the docgen tool got updated

@turbolent turbolent self-assigned this Feb 10, 2023
@turbolent turbolent changed the title Resource function comments not being fully generated [DocGen] Resource function comments not being fully generated Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug The issue represents a bug, malfunction, regression Feedback Good First Issue
Projects
None yet
Development

No branches or pull requests

3 participants