Document new short address toString behaviour

[turbolent]

Work towards #1690

---

• 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

[codecov]

Codecov Report

Merging #1699 (2a61565) into master (16c5038) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1699   +/-   ##
=======================================
  Coverage   76.64%   76.64%           
=======================================
  Files         292      292           
  Lines       61199    61199           
=======================================
  Hits        46904    46904           
  Misses      12682    12682           
  Partials     1613     1613           

Flag	Coverage Δ
unittests	76.64% <ø> (ø)

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

---

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 16c5038...2a61565. Read the comment docs.

[github-actions]

Cadence Benchstat comparison

This branch with compared with the base branch onflow:master commit 16c5038
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.

Results

	old.txt	new.txt
	time/op		delta
CheckContractInterfaceFungibleTokenConformance-2	139µs ± 6%	142µs ±10%	~	(p=0.902 n=7+7)
ContractInterfaceFungibleToken-2	42.2µs ± 6%	43.2µs ±12%	~	(p=0.535 n=7+7)
InterpretRecursionFib-2	2.85ms ± 8%	2.91ms ± 7%	~	(p=0.318 n=7+7)
NewInterpreter/new_interpreter-2	1.05µs ± 5%	1.12µs ±12%	+6.52%	(p=0.023 n=7+7)
NewInterpreter/new_sub-interpreter-2	2.21µs ± 6%	2.25µs ± 4%	~	(p=0.295 n=7+6)
ParseArray-2	8.46ms ± 4%	8.64ms ± 6%	~	(p=0.620 n=7+7)
ParseDeploy/byte_array-2	12.9ms ± 7%	13.0ms ± 5%	~	(p=0.620 n=7+7)
ParseDeploy/decode_hex-2	1.06ms ± 5%	1.07ms ± 4%	~	(p=0.366 n=7+6)
ParseFungibleToken/With_memory_metering-2	198µs ± 4%	200µs ± 8%	~	(p=1.000 n=7+7)
ParseFungibleToken/Without_memory_metering-2	152µs ± 5%	153µs ± 5%	~	(p=0.836 n=7+6)
ParseInfix-2	7.40µs ± 6%	7.63µs ± 6%	~	(p=0.259 n=7+7)
QualifiedIdentifierCreation/One_level-2	2.48ns ± 9%	2.57ns ± 8%	~	(p=0.164 n=7+7)
QualifiedIdentifierCreation/Three_levels-2	133ns ± 5%	136ns ± 7%	~	(p=0.383 n=7+7)
RuntimeFungibleTokenTransfer-2	1.19ms ±23%	1.02ms ± 3%	~	(p=0.138 n=7+6)
RuntimeResourceDictionaryValues-2	6.49ms ± 9%	6.50ms ± 6%	~	(p=0.805 n=7+7)
Transfer-2	82.5ns ± 3%	85.4ns ± 6%	~	(p=0.138 n=6+7)
	alloc/op		delta
CheckContractInterfaceFungibleTokenConformance-2	66.3kB ± 0%	66.3kB ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	26.7kB ± 0%	26.7kB ± 0%	~	(all equal)
InterpretRecursionFib-2	1.25MB ± 0%	1.25MB ± 0%	~	(p=0.545 n=5+6)
NewInterpreter/new_interpreter-2	872B ± 0%	872B ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	1.38kB ± 0%	1.38kB ± 0%	~	(all equal)
ParseArray-2	2.79MB ± 2%	2.83MB ± 3%	~	(p=0.364 n=7+7)
ParseDeploy/byte_array-2	4.39MB ± 3%	4.47MB ± 3%	~	(p=0.318 n=7+7)
ParseDeploy/decode_hex-2	214kB ± 0%	214kB ± 0%	~	(p=0.062 n=7+7)
ParseFungibleToken/With_memory_metering-2	36.3kB ± 0%	36.3kB ± 0%	~	(p=0.851 n=7+7)
ParseFungibleToken/Without_memory_metering-2	36.3kB ± 0%	36.3kB ± 0%	~	(p=1.000 n=7+7)
ParseInfix-2	2.17kB ± 0%	2.17kB ± 0%	~	(p=0.689 n=7+7)
QualifiedIdentifierCreation/One_level-2	0.00B	0.00B	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	64.0B ± 0%	64.0B ± 0%	~	(all equal)
RuntimeFungibleTokenTransfer-2	237kB ± 0%	236kB ± 0%	~	(p=0.366 n=7+6)
RuntimeResourceDictionaryValues-2	2.25MB ± 0%	2.25MB ± 0%	~	(p=0.902 n=7+7)
Transfer-2	48.0B ± 0%	48.0B ± 0%	~	(all equal)
	allocs/op		delta
CheckContractInterfaceFungibleTokenConformance-2	1.07k ± 0%	1.07k ± 0%	~	(all equal)
ContractInterfaceFungibleToken-2	460 ± 0%	460 ± 0%	~	(all equal)
InterpretRecursionFib-2	23.8k ± 0%	23.8k ± 0%	~	(all equal)
NewInterpreter/new_interpreter-2	12.0 ± 0%	12.0 ± 0%	~	(all equal)
NewInterpreter/new_sub-interpreter-2	40.0 ± 0%	40.0 ± 0%	~	(all equal)
ParseArray-2	70.0k ± 0%	70.0k ± 0%	~	(p=0.192 n=7+7)
ParseDeploy/byte_array-2	105k ± 0%	105k ± 0%	~	(p=0.192 n=7+7)
ParseDeploy/decode_hex-2	78.0 ± 0%	78.0 ± 0%	~	(all equal)
ParseFungibleToken/With_memory_metering-2	1.06k ± 0%	1.06k ± 0%	~	(all equal)
ParseFungibleToken/Without_memory_metering-2	1.06k ± 0%	1.06k ± 0%	~	(all equal)
ParseInfix-2	66.0 ± 0%	66.0 ± 0%	~	(all equal)
QualifiedIdentifierCreation/One_level-2	0.00	0.00	~	(all equal)
QualifiedIdentifierCreation/Three_levels-2	2.00 ± 0%	2.00 ± 0%	~	(all equal)
RuntimeFungibleTokenTransfer-2	4.52k ± 0%	4.52k ± 0%	~	(p=0.245 n=7+6)
RuntimeResourceDictionaryValues-2	37.6k ± 0%	37.6k ± 0%	~	(p=0.720 n=7+7)
Transfer-2	1.00 ± 0%	1.00 ± 0%	~	(all equal)