chore(docs): replace term materializer with function for user facing concepts

[michael-0acf4]

Materializer and function might introduce confusion as they are pretty much the same thing from the user point of view, one can be defined in terms of the other.

Migration notes

None

• The change comes with new or modified tests
• Hard-to-understand functions have explanatory comments
• End-user documentation is updated to reflect the change

Summary by CodeRabbit

• Documentation
  • Updated terminology from "materializers" to "functions" across various documentation files to reflect a semantic shift and provide clearer descriptions.
  • Improved clarity in descriptions of custom functions, runtimes, and their roles in the Metatype computing model.
  • Corrected typos and refined explanations in multiple guides and reference documents.

These changes enhance the readability and consistency of our documentation, making it easier for users to understand and implement the features and concepts within the system.

[linear]

MET-546 (docs, bikeshed) replace term "materializer" with "function"

[michael-0acf4]

@coderabbitai review

[coderabbitai]

Walkthrough

The overall change involves updating terminology from "materializers" to "functions" across various Python, TypeScript, and documentation files. This semantic shift aims to clarify the role of these entities in transforming inputs to outputs, reflecting their true purpose in the system. The changes affect comments, documentation, and code descriptions to ensure consistency and clarity in the terminology used throughout the project.

Changes

Files/Paths	Change Summary
examples/typegraphs/first-typegraph.py	Updated comment from "input → output via materializer" to "input → output via runtime function."
examples/typegraphs/first-typegraph.ts	Modified comment from "input → output via materializer" to "input → output via runtime function."
examples/typegraphs/func-gql.py	Updated comment from "can access these root materializers" to "can access these root functions."
examples/typegraphs/func-gql.ts	Changed comment from "custom functions" to "functions."
examples/typegraphs/math.py	Updated comment from "all materializers have inputs and outputs" to "all functions have inputs and outputs."
examples/typegraphs/math.ts	Modified comment from "all materializers have inputs and outputs" to "all functions have inputs and outputs."
examples/typegraphs/policies.py	Updated comment from "set default policy for below materializers" to "set default policy for the exposed functions."
examples/typegraphs/policies.ts	Changed comment from "set default policy for materializers" to "set default policy for the exposed functions."
website/docs/concepts/access-control/...	Updated terminology from "materializers" to "functions" for access control specifications.
website/docs/concepts/features-overview/...	Changed terminology from "materializers" to "functions" throughout the document.
website/docs/concepts/mental-model/...	Updated terminology from "materializers" to "functions" and clarified runtimes association.
website/docs/guides/external-functions/...	Updated terminology from "materializers" to "functions" and "generators."
website/docs/guides/import-external-modules/...	Corrected typo and updated description from "materializers" to "functions."
website/docs/guides/import-your-existing-apis/...	Changed descriptions from "types and materializers" to "types and functions" and from "materializers" to "functions."
website/docs/guides/rest/...	Replaced references to "root materializers" with "root functions" and corrected related terminology.
website/docs/reference/policies/...	Updated terminology from "Policies and materializers" to "Policies and functions."
website/docs/reference/runtimes/deno/...	Changed description from "custom logic and materializers" to "custom logic and functions."
website/docs/reference/runtimes/prisma/...	Updated description to reflect change from manipulating materializers to functions.
website/docs/reference/runtimes/random/...	Changed text from "inject random values to a materializer input" to "inject random values to a function input."
website/docs/reference/types/functions.mdx	Redefined "Effects" from being a property of materializers to being a property of functions.
website/docs/reference/types/importers/...	Clarified that importers support types and functions, not just types.
website/docs/tutorials/metatype-basics/...	Changed terminology from "Materializer" to "Function" throughout the document.
website/shared/projects/tab-first-project-python.mdx	Updated description of hello endpoint from "materializer" to "function."
website/shared/projects/tab-first-project-ts.mdx	Replaced reference to a materializer with a reference to a function in the description of the add endpoint.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to full the review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.00%. Comparing base (01d5b1a) to head (4c7fb3a).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #736   +/-   ##
=======================================
  Coverage   73.00%   73.00%           
=======================================
  Files         117      117           
  Lines       14171    14171           
  Branches     1414     1415    +1     
=======================================
  Hits        10345    10345           
  Misses       3799     3799           
  Partials       27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[zifeo]

I suppose we may miss some rephrasing but that's good enough for now

[michael-0acf4]

I suppose we may miss some rephrasing but that's good enough for now

I tried to fix/remove a few things but I guess that's expected since most had the materializer concept in mind, functions was rather used to refer the node/type.

[destifo]

I wonder though what this means to the abbreviation "MDK"

[michael-0acf4]

I wonder though what this means to the abbreviation "MDK"

We should keep that, I think we can define materializer in the MDK section instead as it would actually mean something concrete to the user there.