provenance-io / provenance

A distributed, proof of stake blockchain designed for the financial services industry.
https://provenance.io
Apache License 2.0
88 stars 39 forks source link

Improve marker net asset value command documentation #2128

Closed nullpointer0x00 closed 1 month ago

nullpointer0x00 commented 2 months ago

Summary

Improve the clarity and usefulness of the documentation for the provenanced tx marker add-net-asset-values command by providing detailed descriptions of the flags, values, and examples.

Problem Definition

The current help documentation for the provenanced tx marker add-net-asset-values command lacks sufficient detail, making it difficult for users to understand how to correctly use the command. Specifically, the documentation does not adequately explain:

This lack of clarity could lead to confusion and errors when users attempt to add or update net asset values for markers on the Provenance blockchain. Improving this documentation would enhance user experience and reduce the likelihood of misuse.

Proposal

  1. Update the Command Help Documentation:

    • Add a clear description for the --value flag, explaining what the input should look like and what it represents.
    • Clarify the example provided, explaining each part of the example, including the use of the ; separator.
    • Specify whether the values set using this command are for a single token or multiple tokens, and provide guidance on how to set values for multiple tokens if applicable.
  2. Include More Detailed Examples:

    • Provide multiple examples showcasing different use cases, such as setting values for a single token and for multiple tokens.
    • Explain any edge cases or potential pitfalls users should be aware of when using the command.
  3. Link to Additional Resources:


For Admin Use


Feel free to modify or add any specific details relevant to your project or the expectations for this ticket.

iramiller commented 2 months ago

Related: #2134

iramiller commented 1 month ago

I considered if there should be some validation on the "volume" parameter (for example, should this ever be higher than the total supply for the marker it is associated with)... But in the end I decided against this because it may need to be a number greater than supply in order to match an integer ratio against the price denom if the token for price is highly valued.