Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(part-5-intro): make "Part 5" obvious #1753

Merged
merged 5 commits into from
Aug 11, 2023
Merged

feat(part-5-intro): make "Part 5" obvious #1753

merged 5 commits into from
Aug 11, 2023

Conversation

ismailarilik
Copy link
Contributor

No description provided.

@tshepang
Copy link
Member

I don't feel like it's worth it, unless this was done for sake of consistency, which itself is lacking in these high-level sections. I would rather remove the "Part X" from the other headings instead.

@tshepang tshepang mentioned this pull request Jul 25, 2023
Closed
@ismailarilik
Copy link
Contributor Author

I don't feel like it's worth it, unless this was done for sake of consistency, which itself is lacking in these high-level sections. I would rather remove the "Part X" from the other headings instead.

There are some references to part numbers, like this one:

image

And this:

image

So I think it would be more consistent to adding part numbers to the first and fifth parts. Also the section How to build and run the compiler might be "Part 0".

But you know better, right? (Since I am very new.) =)

So for consistency, there are two ways:

  1. Removing part info from headers. The reference in the second picture above should also be adjusted not to have part number.
  2. Adding part info to the headers which don't have it. This doesn't require any other change.

There is also one concern: In any case do we need to change file names (add or remove part numbers)?

Please guide me. =)

@tshepang
Copy link
Member

Part numbers were decided without my involvement, so maybe someone that remembers justification would comment. As for me, I would get rid of them altogether.

Maybe let's wait for a week or so, and if no one comments, we can decide together.

Whatever happens, I would not change the file names, unless we add redirects (see book.toml for where this is done).

@ismailarilik
Copy link
Contributor Author

Part numbers were decided without my involvement, so maybe someone that remembers justification would comment. As for me, I would get rid of them altogether.

Maybe let's wait for a week or so, and if no one comments, we can decide together.

Whatever happens, I would not change the file names, unless we add redirects (see book.toml for where this is done).

It's been almost two weeks so what do you think? I am OK with the current state.

@tshepang
Copy link
Member

tshepang commented Aug 7, 2023

am in favor of removing part info from headers

@ismailarilik
Copy link
Contributor Author

Hmm, I am just wondering why. They are parts so can have part numbers. The URL also have part numbers for all parts except the first one. Isn't it self-descriptive?

@tshepang
Copy link
Member

tshepang commented Aug 8, 2023

Parts feel to me like organisational things, not things that should be exposed in headings. That is, am happy if with go with option 2, where we remove "Part X" in headings, even if we leave the file names unchanged.

@ismailarilik
Copy link
Contributor Author

@tshepang how is it now?

@tshepang tshepang merged commit 3c5c746 into rust-lang:master Aug 11, 2023
1 check passed
tshepang
tshepang reviewed Aug 11, 2023
View reviewed changes
src/part-2-intro.md Outdated
@@ -7,7 +7,7 @@ end-to-end process of compilation _and_ readers interested in learning about a
specific system they wish to contribute to. If anything is unclear, feel free
to file an issue on the [rustc-dev-guide
repo](https://github.com/rust-lang/rustc-dev-guide/issues) or contact the compiler
team, as detailed in [this chapter](./compiler-team.md).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not have reverted this

@rustbot rustbot mentioned this pull request Aug 14, 2023
Merged
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Aug 14, 2023
@matthiaskrgr
Rollup merge of rust-lang#114815 - rustbot:docs-update, r=ehuss
e0ee40f 
Update books

## rust-lang/book

3 commits in 668c64760b5c7ea654facb4ba5fe9faddfda27cc..72187f5cd0beaaa9c6f584156bcd88f921871e83
2023-08-04 14:42:07 UTC to 2023-08-03 13:36:44 UTC

- redirects: change link for the `#![no_std]` tutorial (rust-lang/book#3705)
- [chpt10.2] - Small wording changes (rust-lang/book#3724)
- Improve sentence (rust-lang/book#3725)

## rust-embedded/book

1 commits in 1e5556dd1b864109985d5871616ae6b9164bcead..99ad2847b865e96d8ae7b333d3ee96963557e621
2023-08-11 06:31:04 UTC to 2023-08-11 06:31:04 UTC

- Fix a small typo in qemu.md (rust-embedded/book#359)

## rust-lang/nomicon

1 commits in 302b995bcb24b70fd883980fd174738c3a10b705..388750b081c0893c275044d37203f97709e058ba
2023-08-10 21:15:21 UTC to 2023-08-10 21:15:21 UTC

- Document thiscall abi (rust-lang/nomicon#311)

## rust-lang/reference

10 commits in 1ea0178266b3f3f613b0fabdaf16a83961c99cdb..d43038932adeb16ada80e206d4c073d851298101
2023-08-12 19:07:28 UTC to 2023-07-16 20:12:46 UTC

- Document thiscall abi (rust-lang/reference#1092)
- add section about implied bounds (rust-lang/reference#1261)
- Clearly specify the `instruction_set` effects (rust-lang/reference#1307)
- Fix merge queue building twice. (rust-lang/reference#1383)
- Clarify UB around immutability & mutation (rust-lang/reference#1385)
- mention the extra const UB (rust-lang/reference#1273)
- Operator expressions: make the note about division by zero clearer. (rust-lang/reference#1384)
- Make unsafe keyword docs less confusing (rust-lang/reference#1379)
- Say that division by zero for primitive types panics (rust-lang/reference#1382)
- Add CI trigger for merge queues. (rust-lang/reference#1381)

## rust-lang/rust-by-example

3 commits in 8a87926a985ce32ca1fad1be4008ee161a0b91eb..07e0df2f006e59d171c6bf3cafa9d61dbeb520d8
2023-07-24 11:37:55 UTC to 2023-07-24 11:35:36 UTC

- Added attribute unused_labels - fixed warning. (rust-lang/rust-by-example#1729)
- more explanation about panic (rust-lang/rust-by-example#1728)
- chore: add the portuguese version of this project to `readme.md` (rust-lang/rust-by-example#1727)

## rust-lang/rustc-dev-guide

31 commits in b5a12d95e32ae53791cc6ab44417774667ed2ac6..b123ab4754127d822ffb38349ce0fbf561f1b2fd
2023-08-14 08:34:59 UTC to 2023-07-11 06:02:34 UTC

- fix: stabilize debugger_visualizer (rust-lang/rustc-dev-guide#1766)
- feat(part-5-intro): make "Part 5" obvious (rust-lang/rustc-dev-guide#1753)
- Update from `#[warn_]` to `#[warning]` diagnostic attributes (rust-lang/rustc-dev-guide#1765)
- Add RPITIT documentation (rust-lang/rustc-dev-guide#1764)
- fix(visitor.md): fix a type name in a code sample (rust-lang/rustc-dev-guide#1762)
- fix(name-resolution): remove unnecessary closing paranthesis (rust-lang/rustc-dev-guide#1760)
- fix(macro-expansion.md): fix the article `an` to `a` (rust-lang/rustc-dev-guide#1759)
- fix(serialization.md): fix the name of a derive macro (rust-lang/rustc-dev-guide#1756)
- fix(serialization.md): add a necessary plural suffix (rust-lang/rustc-dev-guide#1757)
- fix(salsa.md): add punctuation to prevent confusion (rust-lang/rustc-dev-guide#1754)
- fix(salsa.md): remove duplicate "To Be" verb (rust-lang/rustc-dev-guide#1755)
- feat(fuzzing.md): make `halfempty` word a link (rust-lang/rustc-dev-guide#1750)
- fix(about.md): use `a` instead of `an` (rust-lang/rustc-dev-guide#1751)
- refactor(git.md): make git-scm links clickable (rust-lang/rustc-dev-guide#1747)
- fix(walkthrough.md) add a comma operator to eliminate ambiguity (rust-lang/rustc-dev-guide#1749)
- fix(git.md): remove a confusing end of sentence character (rust-lang/rustc-dev-guide#1748)
- refactor(profiling/with_perf): remove a wrong to be verb (rust-lang/rustc-dev-guide#1746)
- refactor(tests/headers): remove duplicate list item (rust-lang/rustc-dev-guide#1745)
- refactor(test/headers.md): make the meaning more obvious (rust-lang/rustc-dev-guide#1744)
- refactor(tests/ui): remove unnecessary duplicate word (rust-lang/rustc-dev-guide#1743)
- refactor(compiletest): remove unnecessary duplicate word (rust-lang/rustc-dev-guide#1742)
- generic_arguments.md: substs -> GenericArgs (rust-lang/rustc-dev-guide#1741)
- fix(suggested): remove an unnecessary and confusing statement (rust-lang/rustc-dev-guide#1739)
- fix(how-to-build-and-run): fix a typo ("fromer" -> "former") (rust-lang/rustc-dev-guide#1736)
- fix(how-to-build-and-run): remove a wrong paragraph (rust-lang/rustc-dev-guide#1735)
- coverage code has moved (rust-lang/rustc-dev-guide#1728)
- linked issue is closed (rust-lang/rustc-dev-guide#1729)
- remove duplicate reference in about-this-guide.md (rust-lang/rustc-dev-guide#1734)
- Explain more in depth what early and late bound generic parameters are (rust-lang/rustc-dev-guide#1732)
- add section for normalization with the new solver (rust-lang/rustc-dev-guide#1731)
- Improve cleanup-crew.md with an example post (rust-lang/rustc-dev-guide#1730)
@rustbot rustbot mentioned this pull request Aug 28, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tshepang tshepang tshepang approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@ismailarilik @tshepang