-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: Add documentation about errors (codespace and codes) #54
docs: Add documentation about errors (codespace and codes) #54
Conversation
bb39f2d
to
ca2ff8b
Compare
Thank you for this work, @ryu1-sakai ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution.
Please add a link to the table of contents at the top of this x/wasm/README.md
.
@loloicci, the information of the documentation was taken from the following code. @zemyblue, I added the link in the table of contents. |
Thank you. How about adding the info on this file path to README? |
I think it's beter not to mention What should be written here is external specifications, not internal designs/implementations. The content added by this PR explains external specifications about errors, which both servers (nodes in case of Finschia) and clients need to know. On the other hand, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
OK, then now we will add error info to README, and after Finschia/finschia-sdk#942 is solved, we will unify the way to manage error info with finschia. |
Description
Adds documentation about errors (codespace and codes) caused by wasm.
Motivation and context
Errors (codespace and codes) are part of the interface between servers (mainnet nodes) and clients.
So their specs need to be clearly defined and described in somewhere shared by both sever and client developers, such as protocols, official documents, etc.
How has this been tested?
Confirmed that
make install
succeeded.Checklist:
CHANGELOG.md
client/docs/swagger-ui/swagger.yaml