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

Lots of undefined for function params descriptions #34

Open
sebastiantf opened this issue May 25, 2022 · 4 comments
Open

Lots of undefined for function params descriptions #34

sebastiantf opened this issue May 25, 2022 · 4 comments

Comments

@sebastiantf
Copy link

sebastiantf commented May 25, 2022

The generated docs are having a lot of undefined for some function parameters function parameters descriptions, while for some function parameters they are are appearing good, even though the Natspec is in the correct format and the same.

When running on debugMode, the dev docs have the correct parameters and descriptions, without any undefined. But they do not persist till the markdown output

I noticed this in the Primitive docs too: https://library.primitive.xyz/technical/smart-contracts/autogenerated-docs/core/PrimitiveEngine#parameters-1

@clemlak
Copy link
Contributor

clemlak commented May 26, 2022

This can happen with unnamed parameters (for example when using public mappings, etc), I'll try to investigate this though, because it's a bit annoying!

@sebastiantf
Copy link
Author

Can you please elaborate "unnamed parameters"? I wasn't using any public mapping. There were some unnamed return variables though.

@clemlak
Copy link
Contributor

clemlak commented May 26, 2022

All right, then this might be the same issue: when parameters are unnamed, Dodoc might export their name as undefined.
Let's see if we can figure something better though, any ideas?

@sebastiantf
Copy link
Author

Oh man! I just realized I was saying the wrong thing 🤦🏻‍♂️

I actually meant that the descriptions for the function params were undefined not exactly the params themselves.

Apologies for the confusion

@sebastiantf sebastiantf changed the title Lots of undefined for function params Lots of undefined for function params descriptions May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants