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 #2122

Merged
merged 1 commit into from
Nov 4, 2022
Merged

Fix documentation #2122

merged 1 commit into from
Nov 4, 2022

Conversation

turbolent
Copy link
Member

Description

Add missing index and type hierarchy pages


  • 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 Nov 4, 2022
@turbolent turbolent self-assigned this Nov 4, 2022
@codecov
Copy link

codecov bot commented Nov 4, 2022

Codecov Report

Merging #2122 (055d2ca) into master (d705c90) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2122   +/-   ##
=======================================
  Coverage   77.75%   77.75%           
=======================================
  Files         305      305           
  Lines       63629    63629           
=======================================
  Hits        49476    49476           
  Misses      12383    12383           
  Partials     1770     1770           
Flag Coverage Δ
unittests 77.75% <ø> (ø)

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit d705c90
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-2121µs ± 3%119µs ± 2%−1.78%(p=0.038 n=7+7)
ContractInterfaceFungibleToken-241.6µs ± 2%40.8µs ± 0%~(p=0.051 n=7+6)
InterpretRecursionFib-22.42ms ± 8%2.40ms ± 5%~(p=0.805 n=7+7)
NewInterpreter/new_interpreter-21.14µs ± 1%1.13µs ± 1%~(p=0.437 n=7+7)
NewInterpreter/new_sub-interpreter-2620ns ± 7%600ns ± 1%−3.24%(p=0.014 n=7+6)
ParseArray-28.51ms ± 6%8.19ms ± 1%−3.75%(p=0.001 n=7+6)
ParseDeploy/byte_array-212.6ms ± 5%12.3ms ± 1%−2.32%(p=0.017 n=7+7)
ParseDeploy/decode_hex-21.22ms ± 1%1.22ms ± 1%~(p=0.731 n=6+7)
ParseFungibleToken/With_memory_metering-2191µs ± 1%192µs ± 3%~(p=0.710 n=7+7)
ParseFungibleToken/Without_memory_metering-2153µs ± 0%154µs ± 2%~(p=0.097 n=7+7)
ParseInfix-27.25µs ± 1%7.24µs ± 1%~(p=0.655 n=7+6)
QualifiedIdentifierCreation/One_level-22.35ns ± 0%2.35ns ± 0%~(p=0.552 n=6+7)
QualifiedIdentifierCreation/Three_levels-2139ns ± 1%139ns ± 1%~(p=0.374 n=6+6)
RuntimeFungibleTokenTransfer-2660µs ±21%609µs ±24%~(p=0.383 n=7+7)
RuntimeResourceDictionaryValues-25.25ms ± 3%5.15ms ± 1%−1.95%(p=0.007 n=7+7)
RuntimeScriptNoop-221.2µs ±31%19.0µs ±32%~(p=0.620 n=7+7)
SuperTypeInference/arrays-2315ns ± 1%317ns ± 2%~(p=0.929 n=7+7)
SuperTypeInference/composites-2130ns ± 0%130ns ± 0%~(p=0.874 n=7+6)
SuperTypeInference/integers-294.0ns ± 0%93.9ns ± 0%~(p=0.509 n=7+7)
ValueIsSubtypeOfSemaType-295.4ns ± 2%96.0ns ± 6%~(p=0.831 n=7+7)
 
alloc/opdelta
CheckContractInterfaceFungibleTokenConformance-250.1kB ± 0%50.1kB ± 0%+0.00%(p=0.033 n=6+7)
ContractInterfaceFungibleToken-224.2kB ± 0%24.2kB ± 0%~(all equal)
InterpretRecursionFib-21.00MB ± 0%1.00MB ± 0%~(p=1.000 n=6+6)
NewInterpreter/new_interpreter-2752B ± 0%752B ± 0%~(all equal)
NewInterpreter/new_sub-interpreter-2200B ± 0%200B ± 0%~(all equal)
ParseArray-22.75MB ± 3%2.69MB ± 2%−2.26%(p=0.008 n=7+6)
ParseDeploy/byte_array-24.23MB ± 3%4.10MB ± 0%−3.14%(p=0.007 n=7+7)
ParseDeploy/decode_hex-2214kB ± 0%214kB ± 0%~(p=0.593 n=7+5)
ParseFungibleToken/With_memory_metering-229.4kB ± 0%29.4kB ± 0%~(p=0.126 n=7+6)
ParseFungibleToken/Without_memory_metering-229.4kB ± 0%29.4kB ± 0%~(p=0.665 n=7+7)
ParseInfix-21.93kB ± 0%1.93kB ± 0%~(p=0.540 n=7+7)
QualifiedIdentifierCreation/One_level-20.00B 0.00B ~(all equal)
QualifiedIdentifierCreation/Three_levels-264.0B ± 0%64.0B ± 0%~(all equal)
RuntimeFungibleTokenTransfer-2103kB ± 1%102kB ± 1%~(p=0.456 n=7+7)
RuntimeResourceDictionaryValues-22.28MB ± 0%2.28MB ± 0%~(p=0.945 n=6+7)
RuntimeScriptNoop-28.36kB ± 0%8.32kB ± 0%−0.53%(p=0.007 n=7+7)
SuperTypeInference/arrays-296.0B ± 0%96.0B ± 0%~(all equal)
SuperTypeInference/composites-20.00B 0.00B ~(all equal)
SuperTypeInference/integers-20.00B 0.00B ~(all equal)
ValueIsSubtypeOfSemaType-248.0B ± 0%48.0B ± 0%~(all equal)
 
allocs/opdelta
CheckContractInterfaceFungibleTokenConformance-2900 ± 0%900 ± 0%~(all equal)
ContractInterfaceFungibleToken-2434 ± 0%434 ± 0%~(all equal)
InterpretRecursionFib-218.9k ± 0%18.9k ± 0%~(all equal)
NewInterpreter/new_interpreter-213.0 ± 0%13.0 ± 0%~(all equal)
NewInterpreter/new_sub-interpreter-24.00 ± 0%4.00 ± 0%~(all equal)
ParseArray-269.6k ± 0%69.6k ± 0%~(p=1.000 n=7+7)
ParseDeploy/byte_array-2104k ± 0%104k ± 0%~(p=1.000 n=7+7)
ParseDeploy/decode_hex-275.0 ± 0%75.0 ± 0%~(all equal)
ParseFungibleToken/With_memory_metering-20.99k ± 0%0.99k ± 0%~(all equal)
ParseFungibleToken/Without_memory_metering-20.99k ± 0%0.99k ± 0%~(all equal)
ParseInfix-260.0 ± 0%60.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-22.06k ± 0%2.06k ± 0%~(all equal)
RuntimeResourceDictionaryValues-237.0k ± 0%37.0k ± 0%~(p=0.939 n=5+7)
RuntimeScriptNoop-2138 ± 0%138 ± 0%~(all equal)
SuperTypeInference/arrays-23.00 ± 0%3.00 ± 0%~(all equal)
SuperTypeInference/composites-20.00 0.00 ~(all equal)
SuperTypeInference/integers-20.00 0.00 ~(all equal)
ValueIsSubtypeOfSemaType-21.00 ± 0%1.00 ± 0%~(all equal)
 

@turbolent turbolent merged commit 7e17bb8 into master Nov 4, 2022
@turbolent turbolent deleted the bastian/fix-docs branch November 4, 2022 21:24
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.

None yet

3 participants