Improvements to the smart contract API README files #37
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Mentioned where the code for the given module is located and that the documentation is generated based on the NatSpec docs in the code. Made the list of smart contracts for the given module a real list.
Merged
| The smart contract API documentation is generated based on the NatSpec format | ||
| documentation in the smart contract source code. | ||
|
|
||
| The Random Bitcoin contracts API docs are available [here](random-beacon-api/generated-docs/index.md). |
There was a problem hiding this comment.
After switching from contracts documentation in single file to multiple files, I missed that we should update also this link:
Suggested change
| The Random Bitcoin contracts API docs are available [here](random-beacon-api/generated-docs/index.md). | |
| The Random Bitcoin contracts API docs are available [here](random-beacon-api/README.md). |
We could update this in this PR. Similar change needed for other project's API's READMEs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Refs threshold-network/tbtc-v2#553
Mentioned where the code for the given module is located and that the documentation is generated based on the NatSpec docs in the code.
Made the list of smart contracts for the given module a real list.