📝 docs: align SEP suite and README entrypoint#43
Merged
Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
- Introduced function-level attributes using the `@name(args)` form. - Updated function headers to include `uses` clauses for better clarity. - Clarified generic constraints syntax and added new reserved keywords. - Improved documentation on error handling and channel usage in examples. - Adjusted the collector function to reflect accurate task completion expectations.
- Updated SEP-0000 to remove the versioning requirement for the design archive. - Enhanced SEP-0001 executive summary to clarify the core syntax and function-signature layout. - Adjusted language in SEP-0003 to specify canonical semantics and effect aliases. - Revised SEP-0005 to emphasize the additive schema for HoleReport and clarified the protocol for typed holes. - Improved SEP-0006 to detail the handling of `spec` blocks and their impact on compiler behavior. - Clarified the accepted surface in SEP-0007 regarding performance-critical patterns and handler binding. - Updated SEP-0008 to reflect changes in versioning and aliasing conventions for packages.
- Updated SEP-0001 to improve the surface area table formatting and clarify local function declarations and cost analysis. - Revised SEP-0002 to refine type representation and clarify the role of EffectSet and ErrorSet. - Enhanced SEP-0003 to specify the effect system's semantics and clarify the intent-oriented effect vocabulary. - Improved SEP-0004 to detail the cost analysis system and clarify the role of the `@unbounded` escape hatch. - Updated SEP-0005 to refine the Hole System's protocol and clarify the structure of HoleReports. - Revised SEP-0006 to enhance the compiler architecture description and clarify the diagnostics architecture. - Improved SEP-0008 to clarify the module and package system and its visibility rules.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposal summary
spec,timeout(expr), andwhen selfrefinements.uses, effect handlers, modules, andselect.Linked discussion
Existing SEP discussions remain linked from each SEP front matter. This PR is a suite-wide consistency cleanup over the accepted SEP-0000 process and the SEP-0001 acceptance pass rather than a new standalone proposal thread.
Checklist
Notes for reviewers
Docs-only change. Validation run locally:
prek run --all-filesuv run scripts/validate_sep_documents.pyuv run scripts/check_sep_index.pyuv run scripts/check_terminology_consistency.pyuv run scripts/check_contract_schemas.py