Add in-code docs #822
Merged
Add in-code docs #822
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
martriay
approved these changes
Nov 26, 2023
| @@ -269,6 +315,11 @@ mod ERC20Component { | |||
| } | |||
|
|
|||
| /// Destroys a `value` amount of tokens from `account`. | |||
| /// | |||
| /// Requirements: | |||
There was a problem hiding this comment.
isn't enough balance a requirement?
martriay
approved these changes
Dec 6, 2023
martriay
approved these changes
Dec 6, 2023
martriay
added a commit
that referenced
this pull request
Dec 13, 2023
* bump to 0.8.0 (#834) * Update PULL_REQUEST_TEMPLATE.md (#827) * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update PULL_REQUEST_TEMPLATE.md * Update RELEASING and CONTRIBUTING (#828) * update RELEASING * fix linting * update CONTRIBUTING * fix emphasis * add changelog to releasing.md * improve live testing guidelines * Update CONTRIBUTING.md Co-authored-by: Andrew Fleming <[email protected]> --------- Co-authored-by: Andrew Fleming <[email protected]> * Add `ERC721ABI` and fix other abis (#761) * fix account abi * fix erc20 abi * fix erc721 abi * reorder internal fns * reorder internal fns * fix comment * reorder fns * fix casing * fix casing * reorder api fns * add dual interfaces link * add camel methods to api * remove imports * re-add src5_state * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * add deployer trait/impl * change non-standard to impls in fn list * fix in-code doc style * fix comments * fix interface order * remove unused impl --------- Co-authored-by: Eric Nordelo <[email protected]> * Update utility docs (#825) * fix: link (#545) * feat: add utility docs * Update docs/modules/ROOT/pages/utilities.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/utilities.adoc Co-authored-by: Andrew Fleming <[email protected]> * Update docs/modules/ROOT/pages/utilities.adoc Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * Update docs/modules/ROOT/pages/utilities.adoc Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * fix: remove drop events * feat: update CHANGELOG * feat: apply review udpates --------- Co-authored-by: Andrew Fleming <[email protected]> * Add in-code docs (#822) * add in-code comment * normalize in-code comments * fix comment * fix comments * fix comments * add double back ticks for comment possessives * add missing reqs * add missing reqs, fix _burn description * fix __execute__ reqs * remove double backticks * remove unused imports * fix: implementation name (#840) * Improve component tests with ComponentState (#836) * refactor: component state in tests * feat: update CHANGELOG * Update CHANGELOG.md Co-authored-by: Martín Triay <[email protected]> * feat: apply review updates * fix: CHANGELOG --------- Co-authored-by: Martín Triay <[email protected]> * Document SRC5 migration (#821) * start migration guide * add links, add register_interfaces example * add supports_interfaces * add supports_interfaces to docs * fix formatting * revert change * Apply suggestions from code review Co-authored-by: Martín Triay <[email protected]> * remove upgrade fn from code block * remove supports_interfaces * add deregister_erc165_interface * change src5 migration title * fix src5 migration doc * fix how-to section * fix formatting * add deregister_erc165_interface * update interface registration section * add link to register_interface * update CHANGELOG * Apply suggestions from code review Co-authored-by: Martín Triay <[email protected]> * remove register_erc165_interface * remove deregister_erc165_interface from utilities * remove deregister from guide * fix import * remove register_interfaces fn from API * remove unused var * add initializable warning --------- Co-authored-by: Martín Triay <[email protected]> * Document Class Hashes (#832) * fix: link (#545) * feat: add page * feat: finish UI * Update docs/modules/ROOT/pages/api/erc721.adoc Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * fix: remove trailing space * feat: update CHANGELOG * Update CHANGELOG.md Co-authored-by: Martín Triay <[email protected]> * feat: apply review updates * feat: apply review updates --------- Co-authored-by: Andrew Fleming <[email protected]> Co-authored-by: Martín Triay <[email protected]> * Update extensibility docs (#823) * add extensibility docs * start setup guide * change file name * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * fix name * change title * change title to component impl * update changelog * add comp storage section * finish new structure * finish edits, add customization section * simplify titles * finish custom impl section * Apply suggestions from code review Co-authored-by: Martín Triay <[email protected]> * fix comp storage section * change section title to setup, minor edits * add cmp storage link, clean up impl section * add cairo book link * add api design tip * Apply suggestions from code review --------- Co-authored-by: Eric Nordelo <[email protected]> Co-authored-by: Martín Triay <[email protected]> * Update docs navbar (#838) * update docs navbar * complete navbar * fix navbar * fix navbar * update changelog * update changelog * fix changelog * update wizard and rename usage -> components * fix broken links * reordered changelog * fix default collapsed sections --------- Co-authored-by: Andrew Fleming <[email protected]> Co-authored-by: Eric Nordelo <[email protected]> Co-authored-by: Andrew Fleming <[email protected]>
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.
Fixes #740.
PR Checklist