Document compiler contracts and refresh contributor guides - #8598
Document compiler contracts and refresh contributor guides#8598cristianoc wants to merge 8 commits into
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3ddd41b7c9
ℹ️ 关于 Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Can't wait for the next one! Reviewed commit: ℹ️ 关于 Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## object-stage0 #8598 +/- ##
==============================================
Coverage 76.33% 76.33%
==============================================
Files 476 476
Lines 63253 63253
==============================================
Hits 48284 48284
Misses 14969 14969
🚀 新建 features to boost your workflow:
|
rescript
@rescript/belt
@rescript/darwin-arm64
@rescript/darwin-x64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/runtime
@rescript/win32-x64
commit: |
cb5a2f7 to
268fa9b
比较
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
The guide refresh unintentionally changed the contributor workflow to creating the pull request before its changelog entry; keep the original policy text. Signed-Off-By: Cristiano Calcagno <ccrisccris@gmail.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PCtQiaDijUqA2fujQXvKUw
Removing the speculative destruct_exn.md design note left this docstring pointing at a deleted file. The note's surviving conclusion - one cannot soundly ask whether an arbitrary value is an exception, and try/catch never needs to - now lives in the comment itself. Signed-Off-By: Cristiano Calcagno <ccrisccris@gmail.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PCtQiaDijUqA2fujQXvKUw
Signed-off-by: Cristiano Calcagno <cristianoc@users.noreply.github.com>
268fa9b to
2a5d740
比较
Stacked on #8597. Documentation only: no behavior change (full test battery and checkformat pass; the two expected-file changes track fixture comments that render inside error snippets).
Code-level contracts
ctype.mli,btype.mli,subst.mli,types.mli: caller contracts for instantiation (instance,instance_poly ~fixed,instance_label), the object-field filters, enlargement, subtyping, copy sessions (with_copy_session,copy_type_desc), mutability cells, andfor_savingindependence.Tsubstmark visibility across nested sessions vs per-session mutability duplication, the representative behavior ofdup_mutability, the pre-tail-unification openness sample inunify_fields, the rewrittencopyheader (level rule,?partial,?envrecords-only), and the two coercion paths at the typecore call site.type_object_field_value/object_field_use_typeand in the type-checker guide, including whytype_label_exp's PR#4862 retry stays label-specific.Guides and discoverability
compiler/ml/README.md(type checker),compiler/syntax/README.md(parser/printer/JSX),compiler/core/README.md(Lambda/JS backend),rewatch/README.md, plus refreshedanalysis/README.mdandtools/README.md. AGENTS.md and CONTRIBUTING.md link every guide, so each maintained document has an incoming link from the repository entry path.compiler/syntax/JSX.md;docs/JSXV4.mdbecomes a short pointer preserving established external links.docs/Syntax.md,docs/Formatter.md(moved),docs/TYPING.adoc, anddocs/reactive_reanalyze_design.md(with itscontext7.jsonentry) are retired after auditing; stale scratch documents undercompiler/core,compiler/ext,compiler/depends, andanalysis/reanalyzeare removed.🤖 Generated with Claude Code
https://claude.ai/code/session_01PCtQiaDijUqA2fujQXvKUw