search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 39 forks source link

chore: Improve descriptions per code review #886

Closed gibson042 closed 10 months ago

gibson042 commented 11 months ago

Stacked on #876

cloudflare-workers-and-pages[bot] commented 11 months ago

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9e50cf2
Status: ✅  Deploy successful!
Preview URL: https://e7218256.documentation-7tp.pages.dev
Branch Preview URL: https://gibson-2023-11-minor-fixes.documentation-7tp.pages.dev

View logs

erights commented 11 months ago

@gibson042 , since it says "Stacked on #876" I changed the github comparison base to reflect that. Makes a lot more sense to me now.

gibson042 commented 11 months ago

I also saw your related question on the base PR. The problem is that we use the term "value" in two contradictory ways: As the value part of an amount, or as the value of a map's key-value mapping. The unqualified term "value" should only refer to the latter. For the value part of an amount, the actual name of the type in the code is already AmountValue.

With this straightened out, any AmountValue is a Key. A value of a CopyMap's key-value mapping may not be a Key.

Done, but it does introduce some minor reading friction: https://github.com/Agoric/documentation/pull/886/commits/fa576aece9f13254e4a4f0625b10d7fba0fc404d