"About This Guide" updates following Guide reorganization #671
Conversation
This file contains 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
mark-i-m
suggested changes
Apr 7, 2020
There was a problem hiding this comment.
Thank @chrissimpkins! Left some minor nits, but r=me after that
src/part-2-intro.md
Outdated
| @@ -1,4 +1,4 @@ | |||
| # Part 2: How rustc works | |||
| # Part 2: How `rustc` Works | |||
There was a problem hiding this comment.
Hmm... I think high-level compiler arch is actually a better name (also in the about this guode section).
src/about-this-guide.md
Outdated
| 3. [Source Code Representation][p3]: Describes the process of taking raw source code from the user and | ||
| transforming it into various forms that the compiler can work with easily | ||
| 4. [Analysis][p4]: discusses the analyses that the compiler uses to check various | ||
| properties of the code and inform later stages of the compile process |
There was a problem hiding this comment.
perhaps add "(e.g., type checking)”
src/about-this-guide.md
Outdated
| transforming it into various forms that the compiler can work with easily | ||
| 4. [Analysis][p4]: discusses the analyses that the compiler uses to check various | ||
| properties of the code and inform later stages of the compile process | ||
| 5. [From MIR to Binaries][p5]: How linked executable machine code is generated |
There was a problem hiding this comment.
Minor nit: can you end each point with a period?
There was a problem hiding this comment.
No problem! Will add them now.
chrissimpkins
changed the title
|
No problem at all! |
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.
This PR updates the About This Guide page with the new section titles/descriptions following the reorganization in #651.