ERC1155 docs #920
ERC1155 docs #920
Conversation
Update error testing and remove tests failing from erc1155
…iro-contracts into feat/erc1155-#572
| * xref:#ERC721Component-owner_of[`++owner_of(self, token_id)++`] | ||
| * xref:#ERC721Component-safe_transfer_from[`++safe_transfer_from(self, from, to, token_id, data)++`] | ||
| * xref:#ERC721Component-transfer_from[`++transfer_from(self, from, to, token_id)++`] | ||
| * xref:#ERC721Component-approve[`++approve(self, to, token_id)++`] |
There was a problem hiding this comment.
isn't this adding a level of indirection?
There was a problem hiding this comment.
There's an indirection level but no added but this IMO. We had a direct link to the interface section, even when the interface doesn't have the full description like requirements, etc... We should add the full explanation of the method instead of a link to the interface as we are doing below. I think that's the scope of another PR, though.
There was a problem hiding this comment.
Continuing this discussion on this thread
There was a problem hiding this comment.
continued the convo in the other thread but isn't this going against what you said? this is adding a level of indirection and in the other thread you vouch for removing indirections
There was a problem hiding this comment.
IMO this should be pointing to ERC721Component, not directly to the interface, but the description shouldn't be pointing to the interface either, as it is currently doing. So the level of indirection added should be fixed by fixing the description, not by maintaining the previous link.
There was a problem hiding this comment.
understood. let's advance with your proposal but let's make sure we give it a proper thought and document the decision later on
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
… into docs/erc1155
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
Co-authored-by: Martín Triay <martriay@gmail.com>
This PR adds documentation for ERC1155, and fixes some inconsistencies in ERC721 docs.