Repository navigation
Add glossary entries for adjustment and fold - #3074
Closed
isHeSatoshi wants to merge 1 commit into
Closed
isHeSatoshi wants to merge 1 commit into
isHeSatoshi wants to merge 1 commit into
Conversation
The glossary explains interning but has nothing for "fold" or "adjustment", two terms that come up while reading the compiler without being defined anywhere in the guide. "fold" has a chapter of its own, which the entry now points at, and the coercions chapter already explains adjustments without the glossary naming them. Also list "interned" alongside "intern", since that is the form the guide's prose uses.
This comment was marked as low quality.
This comment was marked as low quality.
Collaborator
|
Thanks for the PR. If you have write access, feel free to merge this PR if it does not need reviews. You can request a review using |
rustbot
added
the
S-waiting-on-review
rustbot
removed
the
S-waiting-on-review
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.
Fixes #1796.
The issue asks for "interner", "interned", "fold" and "adjustment" to be in the glossary. Two of those were genuinely missing and two were already covered:
foldandadjustmenthad no mention in the glossary at all, so they are added.internalready had an entry, so I only listed "interned" next to it, which is the form the guide's own prose uses (overview.mdsays "interned symbols",ty.mdmentionsInterned,macro-expansion.mdsays "an internedSymbol"). "Interner" itself does not appear anywhere in the guide, so I did not add it; the nearest thing isCtxtInternersin the memory chapter, which the existing entry already links to.Both new entries point at material that already exists rather than restating it:
fold→ty-fold.md, the chapter onTypeFoldableandTypeFolder.adjustment→ the "Adjustments" section ofhir-typeck/coercions.md, which explains that coercions record adjustments intoTypeckResults, and that they are made explicit when THIR is built.Checks
../ty-fold.mdand../hir-typeck/coercions.md, and the#adjustmentsanchor matches the### Adjustmentsheading at line 97 of that file.|at column 47) and sit in alphabetical order between their neighbours:abby,adjustment,arenaandfat pointer,fold,free variable.RUSTC_BOOTSTRAP=1 cargo run --release --manifest-path ci/sembr/Cargo.toml srcreportssrc/appendix/glossary.mdas compliant.