aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-doc
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-09-28 06:18:32 +0800
committerFabio Berger <me@fabioberger.com>2018-09-28 06:18:32 +0800
commit95e84aae49d86ed8edf286bc8c95214f5b2456c7 (patch)
treeb6372353c8866dd3c378b371703c86461d7d97ef /packages/sol-doc
parent338b7d2ec04ce97f5e381ef49f4545cb12956f6a (diff)
downloaddexon-0x-contracts-95e84aae49d86ed8edf286bc8c95214f5b2456c7.tar.gz
dexon-0x-contracts-95e84aae49d86ed8edf286bc8c95214f5b2456c7.tar.zst
dexon-0x-contracts-95e84aae49d86ed8edf286bc8c95214f5b2456c7.zip
Improve comment
Diffstat (limited to 'packages/sol-doc')
-rw-r--r--packages/sol-doc/src/solidity_doc_generator.ts8
1 files changed, 4 insertions, 4 deletions
diff --git a/packages/sol-doc/src/solidity_doc_generator.ts b/packages/sol-doc/src/solidity_doc_generator.ts
index c70f54d5f..1e9c7d5d7 100644
--- a/packages/sol-doc/src/solidity_doc_generator.ts
+++ b/packages/sol-doc/src/solidity_doc_generator.ts
@@ -28,11 +28,11 @@ import {
TypeDocTypes,
} from '@0xproject/types';
-// Unforunately, the only way to currently retrieve the declared structs with Solidity contracts
-// is to tease it out of the params/return values included in it's ABI. These structures do
-// not include the structs actual name, so we needed a mapping to assign the proper name to a
+// Unforunately, the only way to currently retrieve the declared structs within Solidity contracts
+// is to tease them out of the params/return values included in the ABI. These structures do
+// not include the structs actual name, so we need a mapping to assign the proper name to a
// struct. If the name is not in this mapping, the structs name will default to the param/return value
-// name.
+// name (which mostly coincide).
const customTypeHashToName: { [hash: string]: string } = {
'52d4a768701076c7bac06e386e430883975eb398732eccba797fd09dd064a60e': 'Order',
'46f7e8c4d144d11a72ce5338458ea37b933500d7a65e740cbca6d16e350eaa48': 'FillResult',