Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Add TypeDocs for the NFT module #9155

Merged
merged 58 commits into from
Dec 22, 2023
Merged

Conversation

Tschakki
Copy link
Contributor

@Tschakki Tschakki commented Nov 24, 2023

What was the problem?

This PR ...

How was it tested?

npx typedoc
open docs/typedoc/index.html

https://liskhq.github.io/lisk-docs/lisk-sdk/references/typedoc/modules/lisk_framework.html

@Tschakki Tschakki self-assigned this Nov 24, 2023
Copy link

codecov bot commented Nov 24, 2023

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (eff5d46) 84.70% compared to head (3e7b2bb) 84.66%.
Report is 14 commits behind head on development.

Additional details and impacted files

Impacted file tree graph

@@               Coverage Diff               @@
##           development    #9155      +/-   ##
===============================================
- Coverage        84.70%   84.66%   -0.05%     
===============================================
  Files              656      657       +1     
  Lines            24138    24071      -67     
  Branches          3500     3492       -8     
===============================================
- Hits             20447    20379      -68     
- Misses            3691     3692       +1     
Files Coverage Δ
...nder/src/bootstrapping/commands/base_ipc_client.ts 100.00% <ø> (ø)
...ommander/src/bootstrapping/commands/config/show.ts 96.15% <100.00%> (ø)
...src/bootstrapping/commands/genesis-block/create.ts 34.88% <ø> (ø)
commander/src/bootstrapping/commands/start.ts 85.91% <100.00%> (ø)
...r/src/bootstrapping/commands/transaction/create.ts 91.08% <100.00%> (+0.08%) ⬆️
...der/src/bootstrapping/commands/transaction/sign.ts 93.05% <ø> (ø)
commander/src/utils/genesis_creation.ts 69.23% <100.00%> (ø)
commander/src/utils/transaction.ts 98.18% <ø> (ø)
elements/lisk-transactions/src/validate.ts 100.00% <100.00%> (ø)
...n-connector-plugin/src/active_validators_update.ts 98.21% <100.00%> (ø)
... and 60 more

... and 1 file with indirect coverage changes

Copy link
Contributor

@ishantiw ishantiw left a comment

Choose a reason for hiding this comment

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

Few more comments around exports

framework/src/engine/consensus/index.ts Outdated Show resolved Hide resolved
framework/src/engine/consensus/index.ts Outdated Show resolved Hide resolved
framework/src/engine/bft/index.ts Outdated Show resolved Hide resolved
framework/src/engine/index.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@TalhaMaliktz TalhaMaliktz left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏼

Copy link
Contributor

@ishantiw ishantiw left a comment

Choose a reason for hiding this comment

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

Great job @Tschakki 👏

Copy link
Contributor

@ishantiw ishantiw left a comment

Choose a reason for hiding this comment

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

We need to re-export the types specifically from framework/src/index.ts file instead of using export * otherwise its not exported from the package when its built.
Please revert all the changes related to re-exporting types and export them individually.

@ishantiw ishantiw merged commit 4f83f98 into development Dec 22, 2023
11 checks passed
@ishantiw ishantiw deleted the 9154-nft-module-typedocs branch December 22, 2023 13:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add NFT module
4 participants