Here are a couple of pointers on how to write consistent Radspec descriptions.
- Limit the evaluated length of a Radspec description to around 72 characters (i.e. the description that is displayed to the end-user)
- Use the imperative mood in the description. A good rule of thumb here is that your description is in imperative mood if you can prepend "Executing this transaction wil ..."
- Explain what and why vs. how (i.e. avoid technical terms)
- Provide context, e.g. amount of tokens being sent, token names etc.
Examples of bad descriptions
- Creates a cryptokitty (not imperative)
- Will create a cryptokitty (will at start of sentence)
- Send ANT (provides no context to the transaction being sent)
Examples of good descriptions
- Create a cryptokitty with the name
name
(uses imperative mood and provides context)
- Create a DAO named
name + '.aragonid.eth'
(provides context, not too technical... it is crypto after all)
- Send
formatAmount(amount, 10^18)
ZRX (provides maximum context)