Skip to content

Commit cb11d49

Browse files
committed
docs: improve on practices
1 parent 24b819c commit cb11d49

File tree

5 files changed

+598
-523
lines changed

5 files changed

+598
-523
lines changed

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
docs
1+
docs/*
2+
!docs/.gitkeep
23
.idea
34
dist/*
45
!dist/esm

lib/algorand.asset.params.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> More detailed explanation about the asset parameters can be added to the documentation

lib/algorand.asset.params.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
11
import {AlgorandEncoder} from "./algorand.encoder.js";
22

33
/**
4+
* Asset Parameters
5+
*
6+
* Specifies the parameters for an asset.
7+
* (apar) when part of an AssetConfig transaction.
8+
*
9+
* #### Quick Start:
10+
* {@includeCode ./algorand.asset.params.spec.ts#imports,quickStart}
11+
*
12+
* {@include ./algorand.asset.params.md}
13+
*
414
* @category Common
15+
* @see {@link AssetConfigTransaction}
516
*/
617
export class AssetParams {
718
/**

0 commit comments

Comments
 (0)