docs-lukso-review.md

ERC725

• The link to specs for each methods has an error. It states: « LSP-725-undefined »

• The link to the contract does not match. It points to the lukso-network repository, instead of the ERC725 repository.



General

• Rename « Links » by « References »
• In these « links » callout, do not use « in » but « : » for consistency. Example:
• “Specification details in <…>” —> change to “Specification details: <…>”
• “Solidity implementation in <…>” —> change to “Solidity implementations: <…>”

• Solidity implementation: put the contract name with « .sol », and as a code block.

• For events, mention « Event topic hash: »

• We should add a blank space between methods, so that it is more spaced out. See below, there is no spacing between the executeRelayCall method and the table of return parameters from the previous method. It looks very "squashed together".

Add a <br/> tag at the end of each method output description.

Libraries

• Problem with @return param being displayed in LSP0Utils, LSP2Utils
• The symbols “<“ and “>” are not parsed correctly. Need to check where this is happening

• Errors in libraries are not parsed.

• We should add a small sentence at the beginning of:

  • Public Methods: to explain that this is to be called publicly (to know how to interact with this function, how to call it from a dApp or another smart contract). Can also add that any method with “public” can be called also internally. Any method with “external” can only be called externally and not internally.
  • Internal Methods: to explain this is to be called internally. Cannot be called publicly