Linter: Automate the generation of documentation for `ink-docs` #1972

jubnzv · 2023-11-03T12:23:26Z

Summary

[n] y/n | Does it introduce breaking changes?
[n] y/n | Is it dependant on the specific version of cargo-contract or pallet-contracts?

Description

This PR introduces a script that extracts documentation from ink_linting lints and saves it to the local ink-docs directory. The markdown formatting of the lints was also improved to make them look better in use.ink.

The corresponding PR in ink-docs: use-ink/ink-docs#284

Checklist before requesting a review

[y] My code follows the style guidelines of this project
[n/a] I have added an entry to CHANGELOG.md
[y] I have commented my code, particularly in hard-to-understand areas
[y] I have added tests that prove my fix is effective or that my feature works
[y] Any dependent changes have been merged and published in downstream modules

This commit introduces a script that extracts documentation from `ink_linting` lints and saves it to the local [ink-docs](https://github.com/paritytech/ink-docs) directory. The markdown formatting of the lints was also improved.

paritytech-cicd-pr · 2023-11-03T13:15:36Z

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

⚠️ The ink! master is ahead of your branch, this might skew the comparison data below. ⚠️
These are the results when building the integration-tests/* contracts from this branch with cargo-contract 4.0.0-alpha-f7dd92d and comparing them to ink! master:

Contract	Upstream Size (kB)	PR Size (kB)	Diff (kB)	Diff (%)	Change
basic-contract-caller	2.967	2.967	0	0	➖
basic-contract-caller/other-contract	1.337	1.337	0	0	➖
call-builder-return-value	8.735	8.735	0	0	➖
call-runtime	1.769	1.769	0	0	➖
conditional-compilation	1.209	1.209	0	0	➖
contract-storage	7.171	7.171	0	0	➖
contract-terminate	1.092	1.092	0	0	➖
contract-transfer	1.444	1.444	0	0	➖
custom-allocator	7.428	7.428	0	0	➖
dns	7.249	7.249	0	0	➖
e2e-call-runtime	1.058	1.058	0	0	➖
e2e-runtime-only-backend	1.635	1.635	0	0	➖
erc1155	13.962	13.968	0.006	0.0429738	📈
erc20	6.687	6.687	0	0	➖
erc721	9.64	9.64	0	0	➖
events	4.763	4.763	0	0	➖
flipper	1.393	1.393	0	0	➖
incrementer	1.221	1.221	0	0	➖
lang-err-integration-tests/call-builder-delegate	2.317	2.317	0	0	➖
lang-err-integration-tests/call-builder	4.847	4.847	0	0	➖
lang-err-integration-tests/constructors-return-value	1.773	1.773	0	0	➖
lang-err-integration-tests/contract-ref	4.328	4.328	0	0	➖
lang-err-integration-tests/integration-flipper	1.571	1.571	0	0	➖
mapping-integration-tests	7.685	7.685	0	0	➖
mother	9.508	9.508	0	0	➖
multi-contract-caller	5.924	5.924	0	0	➖
multi-contract-caller/accumulator	1.095	1.095	0	0	➖
multi-contract-caller/adder	1.669	1.669	0	0	➖
multi-contract-caller/subber	1.689	1.689	0	0	➖
multisig	21.471	21.471	0	0	➖
payment-channel	5.501	5.501	0	0	➖
sr25519-verification	0.865	0.865	0	0	➖
static-buffer	1.405	1.405	0	0	➖
trait-dyn-cross-contract-calls	2.466	2.466	0	0	➖
trait-dyn-cross-contract-calls/contracts/incrementer	1.305	1.305	0	0	➖
trait-erc20	7.063	7.063	0	0	➖
trait-flipper	1.209	1.209	0	0	➖
trait-incrementer	1.37	1.37	0	0	➖
upgradeable-contracts/delegator	2.908	2.908	0	0	➖
upgradeable-contracts/delegator/delegatee	1.369	1.369	0	0	➖
upgradeable-contracts/set-code-hash	1.464	1.464	0	0	➖
upgradeable-contracts/set-code-hash/updated-incrementer	1.443	1.443	0	0	➖
wildcard-selector	2.622	2.622	0	0	➖

Link to the run | Last update: Fri Nov 3 14:15:36 CET 2023

jubnzv · 2023-12-21T17:13:02Z

The script should be updated after #2032 is merged

github-actions · 2024-01-15T17:46:13Z

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

These are the results when building the integration-tests/* contracts from this branch with cargo-contract and comparing them to ink! master:

Contract	Upstream Size (kB)	PR Size (kB)	Change
basic-contract-caller	3.207	3.207	➖
basic-contract-caller/other-contract	1.581	1.581	➖
call-builder-return-value	8.904	8.904	➖
call-runtime	2.013	2.013	➖
conditional-compilation	1.453	1.453	➖
contract-storage	7.336	7.336	➖
contract-terminate	1.336	1.336	➖
contract-transfer	1.693	1.693	➖
custom-allocator	7.652	7.652	➖
dns	7.321	7.321	➖
e2e-call-runtime	1.302	1.302	➖
e2e-runtime-only-backend	1.879	1.879	➖
erc1155	14.123	14.123	➖
erc20	6.918	6.918	➖
erc721	9.816	9.816	➖
events	5.264	5.264	➖
flipper	1.637	1.637	➖
incrementer	1.504	1.504	➖
lang-err-integration-tests/call-builder-delegate	2.561	2.561	➖
lang-err-integration-tests/call-builder	5.087	5.087	➖
lang-err-integration-tests/constructors-return-value	1.987	1.987	➖
lang-err-integration-tests/contract-ref	4.568	4.568	➖
lang-err-integration-tests/integration-flipper	1.815	1.815	➖
lazyvec-integration-test	4.553	4.553	➖
mapping-integration-tests	7.919	7.919	➖
mother	12.756	12.756	➖
multi-contract-caller	6.155	6.155	➖
multi-contract-caller/accumulator	1.378	1.378	➖
multi-contract-caller/adder	1.908	1.908	➖
multi-contract-caller/subber	1.928	1.928	➖
multisig	21.621	21.621	➖
payment-channel	5.653	5.653	➖
sr25519-verification	1.148	1.148	➖
static-buffer	1.649	1.649	➖
trait-dyn-cross-contract-calls	2.706	2.706	➖
trait-dyn-cross-contract-calls/contracts/incrementer	1.549	1.549	➖
trait-erc20	7.294	7.294	➖
trait-flipper	1.453	1.453	➖
trait-incrementer	1.614	1.614	➖
upgradeable-contracts/delegator	3.152	3.152	➖
upgradeable-contracts/delegator/delegatee	1.613	1.613	➖
upgradeable-contracts/set-code-hash	1.747	1.747	➖
upgradeable-contracts/set-code-hash/updated-incrementer	1.726	1.726	➖
wildcard-selector	2.852	2.852	➖

Link to the run | Last update: Thu Jan 18 12:03:32 CET 2024

codecov-commenter · 2024-01-17T12:33:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (49db0b5) 53.62% compared to head (a196595) 53.59%.
Report is 5 commits behind head on master.

❗ Current head a196595 differs from pull request most recent head 98bf33a. Consider uploading reports for the commit 98bf33a to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1972      +/-   ##
==========================================
- Coverage   53.62%   53.59%   -0.03%     
==========================================
  Files         224      224              
  Lines        7107     7107              
  Branches     3146     3146              
==========================================
- Hits         3811     3809       -2     
- Misses       3296     3298       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

scripts/generate_linter_docs.sh

cmichi

That's great, thx!

jubnzv marked this pull request as ready for review November 7, 2023 11:35

jubnzv requested review from cmichi, ascjones and SkymanOne as code owners November 7, 2023 11:35

jubnzv mentioned this pull request Nov 7, 2023

Add ink_linting documentation use-ink/ink-docs#284

Merged

jubnzv added 3 commits January 15, 2024 13:27

Merge remote-tracking branch 'origin/master' into linter-docs

466f70d

chore(script): Update after use-ink#2032 is merged

5dcc0b2

chore(linter): Wrap in docstring to improve appearance

a196595

cmichi reviewed Jan 18, 2024

View reviewed changes

scripts/generate_linter_docs.sh Show resolved Hide resolved

cmichi approved these changes Jan 18, 2024

View reviewed changes

Update scripts/generate_linter_docs.sh

98bf33a

cmichi merged commit b05e7f2 into use-ink:master Jan 18, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Linter: Automate the generation of documentation for `ink-docs` #1972

Linter: Automate the generation of documentation for `ink-docs` #1972

jubnzv commented Nov 3, 2023

paritytech-cicd-pr commented Nov 3, 2023

jubnzv commented Dec 21, 2023

github-actions bot commented Jan 15, 2024 •

edited

Loading

codecov-commenter commented Jan 17, 2024 •

edited

Loading

cmichi left a comment

Linter: Automate the generation of documentation for ink-docs #1972

Linter: Automate the generation of documentation for ink-docs #1972

Conversation

jubnzv commented Nov 3, 2023

Summary

Description

Checklist before requesting a review

paritytech-cicd-pr commented Nov 3, 2023

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

jubnzv commented Dec 21, 2023

github-actions bot commented Jan 15, 2024 • edited Loading

🦑 📈 ink! Example Contracts ‒ Changes Report 📉 🦑

codecov-commenter commented Jan 17, 2024 • edited Loading

Codecov Report

cmichi left a comment

Choose a reason for hiding this comment

Linter: Automate the generation of documentation for `ink-docs` #1972

Linter: Automate the generation of documentation for `ink-docs` #1972

github-actions bot commented Jan 15, 2024 •

edited

Loading

codecov-commenter commented Jan 17, 2024 •

edited

Loading