Skip to content

docs: correct stale facts across the documentation suite - #14

Merged
mitchellnemitz merged 1 commit into
mainfrom
docs-2026-07-24-doc-accuracy-audit
Jul 24, 2026
Merged

mitchellnemitz merged 1 commit into
mainfrom
docs-2026-07-24-doc-accuracy-audit

Conversation

@mitchellnemitz

Copy link
Copy Markdown
Owner

Audited the entire documentation suite (11 site docs plus the repo docs) against the current compiler and tooling, and fixed 14 inaccuracies. Every finding was cross-checked against source before the edit; docslint and doctest pass and no source was touched.

stdlib-index.md

  • env.get returns Optional[string], not string (core_members.go)
  • comparable admits float and value enums now; dropped "float excluded"
  • run_full and tuple destructuring are implemented, not deferred; only a destructuring match remains
  • added the missing array.is_empty and dict.is_empty entries
  • namespaced spellings process.run_env / env.set, not the bare names

stdlib.md

  • Optional[float] is comparable (numeric identity); only Optional of a value enum or an aggregate stays non-comparable

language.md

  • only 4 of the 12 generic funcref builtins span more than one container (map, filter, and_then, or_else); the other 8 are single-container
  • 71 monomorphic-generatable builtins, not 75
  • 8 BuiltinFuncrefClass labels, not 9
  • Arrays/Dicts snippets need import "array" / import "dict"

internals.md, CONTRIBUTING.md

  • CI runs four jobs; added release-dryrun (goreleaser config check + snapshot build)

www/README.md

  • dev server serves under localhost:4321/wisp/ (astro base=/wisp)

README.md, CONTRIBUTING.md

  • Go 1.26.4 or newer, matching the go.mod floor

Audited the full docs suite against the current compiler and tooling and
fixed 14 inaccuracies found by cross-checking source:

stdlib-index.md
- env.get returns Optional[string], not string
- comparable now admits float and value enums (drop "float excluded")
- run_full and tuple destructuring are implemented, not deferred
- add the missing array.is_empty and dict.is_empty entries
- namespaced spellings process.run_env / env.set, not the bare names

stdlib.md
- Optional[float] is comparable (numeric identity); only Optional of a
  value enum or an aggregate stays non-comparable

language.md
- only 4 of the 12 generic funcref builtins span more than one container
  (map, filter, and_then, or_else); the rest are single-container
- 71 monomorphic-generatable builtins, not 75
- 8 BuiltinFuncrefClass labels, not 9
- Arrays/Dicts snippets need import "array" / import "dict"

internals.md, CONTRIBUTING.md
- CI runs four jobs; add release-dryrun (goreleaser check + snapshot)

www/README.md
- dev server serves under localhost:4321/wisp/ (astro base=/wisp)

README.md, CONTRIBUTING.md
- Go 1.26.4 or newer, matching the go.mod floor

docslint and doctest pass; no source changed.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@mitchellnemitz
mitchellnemitz merged commit b56b5ad into main Jul 24, 2026
8 checks passed
@mitchellnemitz
mitchellnemitz deleted the docs-2026-07-24-doc-accuracy-audit branch July 24, 2026 17:39
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.

1 participant