docs: improve documentation for audit release #178
Merged
Conversation
This file contains 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
hallazzang
suggested changes
Oct 18, 2021
9 tasks
dongsam
suggested changes
Oct 18, 2021
this prevents from consuming 0 additional gas but calling `GetParams`
Co-authored-by: JayB <[email protected]>
Co-authored-by: JayB <[email protected]>
Co-authored-by: JayB <[email protected]>
docs: update docs
…ogisin/farming into kogisin/172-improve-docs-audit * 'kogisin/172-improve-docs-audit' of https:/kogisin/farming: Update x/farming/spec/03_state_transitions.md Update x/farming/spec/03_state_transitions.md Update x/farming/spec/03_state_transitions.md docs: update docs for `Stake` state transition docs: update doc for `DelayedStakingGasFee` fix: consume additional gas only if needed
hallazzang
suggested changes
Oct 18, 2021
dongsam
approved these changes
Oct 18, 2021
jaybxyz
added a commit
to jaybxyz/farming
that referenced
this pull request
Oct 27, 2021
* master: (22 commits) fix: use farmingPoolAcc and terminationAcc for consistency docs: add missing comments fix: last add_request_proposals docs: update renamed variables and remove mvp_legacy.md feat: rename public plan proposal requests feat: rename NewPublicPlanProposal to NewPublicPlanProposalHandler docs: update README.md fix: workflow target branch and description for main branch doc: fix to be broken links by renaming branch name move codeowners from contributing file to the CODEOWNERS file create CODEOWNERS file feat: generate proto files edit farming.proto docs: add os checking for sed -i option (tendermint#184) docs: specify which module is used for module name feat: bump budget to v0.1.1 (tendermint#177) docs: improve documentation for audit release (tendermint#178) fix: withdraw rewards only when staked amount changes (tendermint#180) fix: emit rewards_withdrawn only when positive amount is withdrawn docs: add helpful docs for audit (tendermint#176) ... # Conflicts: # x/farming/simulation/proposals.go
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.
Description
This PR is the last one to improve documentation quality for the upcoming audit release before we work on #172.
Let's make documentation easy to read and resourceful. Make sure that all the necessary contents are there for other developers and auditors to test.
Tasks
specdocs up to dateBefore we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.
docs/) or specification (x/<module>/spec/)godoccomments.Files changedin the Github PR explorerCodecov Reportin the comment section below once CI passes