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

Rename entities across the docs #258

Open
novusnota opened this issue Jun 12, 2024 · 1 comment
Open

Rename entities across the docs #258

novusnota opened this issue Jun 12, 2024 · 1 comment
Assignees
Labels
docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs: Cookbook /cookbook section of the docs: "How-Tos" and complete code examples for various use-cases docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution

Comments

@novusnota
Copy link
Member

novusnota commented Jun 12, 2024

For simplicity, clarity, and, in some regard, conformance to grammar.ohm, I propose renaming of many terms throughout the docs.

Changes:

  • global static functions -> global functions
  • internal functions -> storage functions
  • persistent state variables -> storage variables
  • constants: global and storage ones
  • getter functions: off-chain functions / accessors (preserve the older "getter" name alongside the new one too)
  • describe that maps are called dicts or dictionaries in FunC, Fift, TVM and various bindings, such that the page about them is easier to find for newcomers from FunC ("dictionaries: hashmap -> map" transition).

Potential changes (not sure):

  • serialization types → storage specifiers/modifiers (especially on book/integers page)
@novusnota novusnota added docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution docs: Cookbook /cookbook section of the docs: "How-Tos" and complete code examples for various use-cases discussion Further information is requested and removed docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution docs: Cookbook /cookbook section of the docs: "How-Tos" and complete code examples for various use-cases labels Jun 12, 2024
@novusnota novusnota changed the title Consider renaming "persistent state variables" to just "storage variables" for simplicity and clarity Consider renaming "persistent state variables" to just "storage variables" Jun 12, 2024
@novusnota novusnota added docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs: Cookbook /cookbook section of the docs: "How-Tos" and complete code examples for various use-cases labels Jun 15, 2024
@novusnota novusnota removed the discussion Further information is requested label Jun 28, 2024
@novusnota novusnota self-assigned this Jun 28, 2024
@novusnota novusnota added this to the v1.4.0 milestone Jun 28, 2024
@novusnota novusnota added the docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution label Jun 28, 2024
@novusnota novusnota changed the title Consider renaming "persistent state variables" to just "storage variables" Rename entities across the docs Jun 30, 2024
@novusnota novusnota added has dependency Depends on another issue and can't be resolved before it and removed has dependency Depends on another issue and can't be resolved before it labels Jun 30, 2024
@novusnota novusnota modified the milestones: v1.4.0, v1.5.0 Jul 23, 2024
@novusnota
Copy link
Member Author

novusnota commented Sep 5, 2024

Also: #374, with "mutating" or "mutation" being the correct choice over "mutable"

@novusnota novusnota modified the milestones: v1.5.0, v1.6.0 Sep 13, 2024
@novusnota novusnota removed this from the v1.6.0 milestone Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs: Book /book section of the docs: Guides, Cheatsheets, and a streamlined sequence of educational materials docs: Cookbook /cookbook section of the docs: "How-Tos" and complete code examples for various use-cases docs: Reference /ref section of the docs: API reference, standard libraries, specification and evolution
Projects
None yet
Development

No branches or pull requests

1 participant