-
Notifications
You must be signed in to change notification settings - Fork 16
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
Comments
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! |
Can you please elaborate "unnamed parameters"? I wasn't using any public mapping. There were some unnamed return variables though. |
All right, then this might be the same issue: when parameters are unnamed, Dodoc might export their name as |
Oh man! I just realized I was saying the wrong thing 🤦🏻♂️ I actually meant that the descriptions for the function params were Apologies for the confusion |
undefined
for function paramsundefined
for function params descriptions
The generated docs are having a lot of
undefined
for somefunction parametersfunction 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
, thedev
docs have the correct parameters and descriptions, without anyundefined
. But they do not persist till the markdown outputI noticed this in the Primitive docs too: https://library.primitive.xyz/technical/smart-contracts/autogenerated-docs/core/PrimitiveEngine#parameters-1
The text was updated successfully, but these errors were encountered: