docs: clarify TransparentWrapper Rule 1 wording - #353
Merged
Lokathor merged 1 commit intoSep 11, 2026
Conversation
Remove the misleading "either" that implied multiple ways to satisfy Rule 1 while only documenting one. Also fix "a either", plural "representations", and odd spacing, and link the language ABI compatibility rules for further reading. Fixes Lokathor#265
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
2 participants
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.
Problem
TransparentWrappersafety Rule 1 used "either" but only described one way to satisfy the rule, which made the docs confusing. The same sentence also had awkward wording ("a either", plural "representations", uneven spacing).Fix
Docs-only change; no code behavior changes.
Test plan
src/transparent.rsFixes #265