Docs have wrong return type when tuples

OpenZeppelin / openzeppelin-sdk

OpenZeppelin SDK repository for CLI and upgrades.js. No longer actively developed.

MIT License

431 stars 200 forks source link

Docs have wrong return type when tuples #1530

Closed ilanolkies closed 4 years ago

ilanolkies commented 4 years ago

Hi!

I think the Smart Contract API docs are wrong when showing tuple returns:

https://github.com/OpenZeppelin/openzeppelin-sdk/blob/c68234271a4a6e29b989fe1bac1902a246a298b3/packages/lib/docs/modules/ROOT/pages/api.adoc#getpackagestring-packagename--contract-package-var-typeuint643-item-kindpublic

Thanks,

frangio commented 4 years ago

Hi @ilanolkies! Thanks for reporting. This is a bug we've fixed in Contracts and haven't ported here yet.

However, this file shouldn't be in the repo in the first place. :slightly_smiling_face: It's generated in the docs build, and you should view it at docs.openzeppelin.com/upgrades/api.

frangio commented 4 years ago

Removed the file in 427fc2ce4305892459aca713f46d9f810ff24087, and fixed the template in f6e3f09efece6c2a36a6c48f982099f9948c1521.