Skip to content

docs: Corrections to Working with models page#486

Merged
developerjamiu merged 1 commit intomainfrom
docs/working-with-models-fact-check
May 7, 2026
Merged

docs: Corrections to Working with models page#486
developerjamiu merged 1 commit intomainfrom
docs/working-with-models-fact-check

Conversation

@developerjamiu
Copy link
Copy Markdown
Contributor

Summary

Fact-checked the Working with models page. Three corrections:

  • Outdated enum default: The page framed byIndex as the default and recommended setting byName because the default would change "in version 3 of Serverpod." That change has already happened — byName is the default in 3.5.0-beta.4. Reworded the section so it states the current default and warns about byIndex instead.
  • distanceFunction keyword row: Listed only l2, innerProduct, cosine, l1, missing jaccard and hamming (used for Bit vectors). Replaced with a pointer to the indexing page, which already documents the full type×index×function matrix.
  • Header style: ## Default Values## Default values per STYLE_GUIDE.md sentence-case rule. Anchor stays the same.

Test plan

  • Render the page locally and confirm the Enum section reads correctly and the keyword table row links work.

@developerjamiu developerjamiu requested review from Swiftaxe and Zfinix May 7, 2026 12:52
Copy link
Copy Markdown
Contributor

@Swiftaxe Swiftaxe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@developerjamiu developerjamiu merged commit d1a7982 into main May 7, 2026
4 checks passed
@developerjamiu developerjamiu deleted the docs/working-with-models-fact-check branch May 7, 2026 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants