rust-lang / rust-lang/rust-by-example
Committed changes not visible - RBE shows old code
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
I have added a TLDR; section at the end. Apologies if this is a very simple error but I just wanted to report this. I am still a beginner.
Issue
I added the following snippet of code - https://github.com/rust-lang/rust-by-example/pull/1878 and the commits were merged.
/* Compound types - Array and Tuple */
// Array signature consists of Type T and length as [T; length].
let my_array: [i32; 5] = [1, 2, 3, 4, 5];
// Tuple is a collection of values of different types
// and is constructed using parentheses ().
let my_tuple = (5u32, 1u8, true, -5.04f32);
But the changes are not visible in the code editor on the relevant page. We can check it here: 2. Primitives
I also fixed the workflow status on README.md but that is visible.
Similar Issue
May 16
- https://github.com/rust-lang/rust-by-example/issues/1846,
- Author mentions that the following comment is incorrect and should be changed.
3.1 - Custom Types > Structures
// Incorrect comment
// `bottom_right.y` will be the same as `point.y` because we used that field
// from `point`
to
// Correct comment
// `bottom_right.y` will be the same as `another_point.y` because we used that field
// from `another_point`
June 6
- Pull request - https://github.com/rust-lang/rust-by-example/pull/1858 , the above was corrected.
- We can see the corrected comment in the repository - https://github.com/rust-lang/rust-by-example/blob/master/src/custom_types/structs.md
But the same is not visible when we view the page online - 3.1 Structures
July 22
- The issue https://github.com/rust-lang/rust-by-example/issues/1866 also occurs because, though the changes were done in the
structs.mdfile, they are not visible correctly on the website.
TLDR;
The .md file and the corresponding generated .html are different.
Check for line 60, 61 in 3.1 Structures .md file
They are not shown correctly on the website: https://doc.rust-lang.org/rust-by-example/custom_types/structs.html
Same for the page Primitives - primitives.md file
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare src/primitives.md and src/custom_types/structs.md with their corresponding pages at doc.rust-lang.org, focusing on the reported differing lines. Then inspect how the Markdown content is generated into the online HTML; the issue is done when the deployed Primitives and Structures pages show the committed source changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100