docs: explain why ilo has no borrow types#401
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Summary
Brief mem/4: add a defensive doc section to
zero-gap-specs/lessons-from-zero.mdexplaining why ilo deliberately has no user-visible borrow type annotations (ref<T>,mutref<T>,owned<T>). Stops future contributors from re-deriving the rationale every time the question comes up, and gives potential users a clear signal that this is a deliberate design choice with tradeoffs we can articulate, not an oversight.Note:
zero-gap-specs/was previously kept locally outside the repo. This PR commits the lessons-from-zero doc into the ilo repo so the planning rationale is version-controlled alongside the code it justifies. The expanded section 5a is the substantive change; the rest of the file is the existing planning doc copied as-is so future edits flow through normal PR review.What's in the diff
### a) Borrow checker / ownership typesin section 5 from a one-line dismissal to a full rationale citing Principles 1 (Token-Conservative) and 4 (Language-Agnostic) by name, plus the "one layer of the stack" framing from section 4h and the manifesto.Test plan
Docs-only change. No code paths touched.
Follow-ups