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

Fix documentation, add linter #1785

Merged
merged 10 commits into from
Jul 8, 2022
Merged

Conversation

turbolent
Copy link
Member

@turbolent turbolent commented Jul 6, 2022

Description

  • Fix all the broken links
  • Add a linter that checks the links and integrate it into CI
  • Improve operator docs

  • Targeted PR against master branch
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work
  • Code follows the standards mentioned here
  • Updated relevant documentation
  • Re-reviewed Files changed in the Github PR explorer
  • Added appropriate labels

@turbolent turbolent added the Documentation Improvements or additions to documentation label Jul 6, 2022
@turbolent turbolent requested a review from alilloig July 6, 2022 04:45
@turbolent turbolent self-assigned this Jul 6, 2022
@turbolent turbolent requested a review from joshuahannan as a code owner July 6, 2022 04:45
Base automatically changed from bastian/improve-documentation to master July 7, 2022 19:48
@github-actions
Copy link

github-actions bot commented Jul 7, 2022

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit 0e19bb9
The command for i in {1..N}; do go test ./... -run=XXX -bench=. -benchmem -shuffle=on; done was used.
Bench tests were run a total of 7 times on each branch.

Collapsed results for better readability

old.txtnew.txt
time/opdelta
CheckContractInterfaceFungibleTokenConformance-2136µs ± 1%135µs ± 0%−1.09%(p=0.002 n=7+6)
ContractInterfaceFungibleToken-242.3µs ± 1%41.9µs ± 1%−0.89%(p=0.007 n=7+7)
InterpretRecursionFib-23.70ms ± 1%3.68ms ± 1%−0.56%(p=0.041 n=6+6)
NewInterpreter/new_interpreter-21.14µs ± 1%1.13µs ± 1%−1.15%(p=0.009 n=6+6)
NewInterpreter/new_sub-interpreter-22.49µs ± 1%2.48µs ± 1%~(p=0.367 n=7+7)
ParseArray-28.37ms ± 1%8.35ms ± 1%~(p=0.534 n=6+7)
ParseDeploy/byte_array-212.7ms ± 1%12.6ms ± 1%~(p=0.181 n=6+7)
ParseDeploy/decode_hex-21.14ms ± 0%1.14ms ± 1%~(p=0.132 n=6+6)
ParseFungibleToken/With_memory_metering-2204µs ± 3%204µs ± 1%~(p=0.731 n=7+6)
ParseFungibleToken/Without_memory_metering-2155µs ± 0%155µs ± 1%~(p=0.534 n=7+6)
ParseInfix-27.70µs ± 0%7.64µs ± 1%~(p=0.055 n=6+7)
QualifiedIdentifierCreation/One_level-22.82ns ± 0%2.42ns ± 0%−14.23%(p=0.001 n=6+7)
QualifiedIdentifierCreation/Three_levels-2121ns ± 1%121ns ± 1%~(p=0.189 n=7+6)
RuntimeFungibleTokenTransfer-21.16ms ±20%1.11ms ±18%~(p=0.620 n=7+7)
RuntimeResourceDictionaryValues-26.32ms ± 2%6.05ms ± 1%−4.26%(p=0.001 n=7+6)
ValueIsSubtypeOfSemaType-279.2ns ± 1%79.4ns ± 2%~(p=1.000 n=6+7)
 
alloc/opdelta
CheckContractInterfaceFungibleTokenConformance-267.0kB ± 0%67.0kB ± 0%~(p=0.462 n=7+7)
ContractInterfaceFungibleToken-226.8kB ± 0%26.8kB ± 0%~(all equal)
InterpretRecursionFib-21.51MB ± 0%1.51MB ± 0%~(p=0.303 n=7+5)
NewInterpreter/new_interpreter-2928B ± 0%928B ± 0%~(all equal)
NewInterpreter/new_sub-interpreter-21.46kB ± 0%1.46kB ± 0%~(all equal)
ParseArray-22.84MB ± 0%2.81MB ± 2%−1.18%(p=0.045 n=5+7)
ParseDeploy/byte_array-24.44MB ± 2%4.39MB ± 3%~(p=0.272 n=7+7)
ParseDeploy/decode_hex-2214kB ± 0%214kB ± 0%~(p=0.729 n=7+7)
ParseFungibleToken/With_memory_metering-236.3kB ± 0%36.3kB ± 0%~(p=0.396 n=7+7)
ParseFungibleToken/Without_memory_metering-236.3kB ± 0%36.3kB ± 0%~(p=0.495 n=7+5)
ParseInfix-22.17kB ± 0%2.17kB ± 0%+0.07%(p=0.003 n=5+7)
QualifiedIdentifierCreation/One_level-20.00B 0.00B ~(all equal)
QualifiedIdentifierCreation/Three_levels-264.0B ± 0%64.0B ± 0%~(all equal)
RuntimeFungibleTokenTransfer-2232kB ± 0%232kB ± 0%~(p=1.000 n=7+7)
RuntimeResourceDictionaryValues-22.25MB ± 0%2.25MB ± 0%~(p=0.456 n=7+7)
ValueIsSubtypeOfSemaType-248.0B ± 0%48.0B ± 0%~(all equal)
 
allocs/opdelta
CheckContractInterfaceFungibleTokenConformance-21.08k ± 0%1.08k ± 0%~(all equal)
ContractInterfaceFungibleToken-2461 ± 0%461 ± 0%~(all equal)
InterpretRecursionFib-233.5k ± 0%33.5k ± 0%~(all equal)
NewInterpreter/new_interpreter-213.0 ± 0%13.0 ± 0%~(all equal)
NewInterpreter/new_sub-interpreter-242.0 ± 0%42.0 ± 0%~(all equal)
ParseArray-270.0k ± 0%70.0k ± 0%~(p=0.318 n=7+5)
ParseDeploy/byte_array-2105k ± 0%105k ± 0%~(p=0.091 n=7+5)
ParseDeploy/decode_hex-277.0 ± 0%77.0 ± 0%~(all equal)
ParseFungibleToken/With_memory_metering-21.06k ± 0%1.06k ± 0%~(all equal)
ParseFungibleToken/Without_memory_metering-21.06k ± 0%1.06k ± 0%~(all equal)
ParseInfix-266.0 ± 0%66.0 ± 0%~(all equal)
QualifiedIdentifierCreation/One_level-20.00 0.00 ~(all equal)
QualifiedIdentifierCreation/Three_levels-22.00 ± 0%2.00 ± 0%~(all equal)
RuntimeFungibleTokenTransfer-24.19k ± 0%4.19k ± 0%~(p=0.592 n=7+7)
RuntimeResourceDictionaryValues-237.5k ± 0%37.5k ± 0%~(p=0.710 n=7+7)
ValueIsSubtypeOfSemaType-21.00 ± 0%1.00 ± 0%~(all equal)
 

@codecov
Copy link

codecov bot commented Jul 8, 2022

Codecov Report

Merging #1785 (868a5ef) into master (0e19bb9) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 868a5ef differs from pull request most recent head 28c4fde. Consider uploading reports for the commit 28c4fde to get more accurate results

@@            Coverage Diff             @@
##           master    #1785      +/-   ##
==========================================
- Coverage   77.38%   77.37%   -0.01%     
==========================================
  Files         306      306              
  Lines       62698    62698              
==========================================
- Hits        48517    48515       -2     
- Misses      12560    12562       +2     
  Partials     1621     1621              
Flag Coverage Δ
unittests 77.37% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
runtime/interpreter/storage.go 69.04% <0.00%> (-1.59%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0e19bb9...28c4fde. Read the comment docs.

Copy link
Member

@joshuahannan joshuahannan left a comment

Choose a reason for hiding this comment

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

Thanks for fixing all these!

docs/language/glossary.md Outdated Show resolved Hide resolved
@turbolent turbolent merged commit 068f4ab into master Jul 8, 2022
@turbolent turbolent deleted the bastian/improve-documentation-2 branch July 8, 2022 16:56
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants