Skip to content
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

Add inline documentation for SRC-20 standard examples #40

Merged
merged 1 commit into from
Nov 16, 2023

Conversation

bitzoic
Copy link
Member

@bitzoic bitzoic commented Nov 14, 2023

Type of change

  • Improvement (refactoring, restructuring repository, cleaning tech debt, ...)
  • Documentation

Changes

The following changes have been made:

  • Adds inline docs to SRC-20 single asset example
  • Adds inline docs to SRC-20 multi asset example

@bitzoic bitzoic added Documentation Improvements or additions to documentation SRC 20 Label used to filter for the standard issue labels Nov 14, 2023
@bitzoic bitzoic self-assigned this Nov 14, 2023
@bitzoic bitzoic requested a review from a team as a code owner November 14, 2023 13:13
/// fn foo(contract_id: ContractId) {
/// let src_20_abi = abi(SRC20, contract_id);
/// let assets = src_20_abi.total_assets();
/// assert(assets == 1);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts on using assert_eq(X, Y) in doc tests instead of assert()?

@bitzoic bitzoic merged commit 4d7d32d into master Nov 16, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation SRC 20 Label used to filter for the standard issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants