Skip to content

README.md: remove language identifier from code blocks or prompts #76863

New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom
Closed
ghost opened this issue Sep 18, 2020 · 4 comments
Closed

README.md: remove language identifier from code blocks or prompts #76863

ghost opened this issue Sep 18, 2020 · 4 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.

Comments

@ghost
Copy link

ghost commented Sep 18, 2020 •
edited by ghost
Loading

code blocks on Readme are marked with sh or batch. but each line begins with $ or > ,which are the prompts.

if someone copy the line and run it, it will fail with a message like zsh: command not found: $( on zsh)

so either the language identifiers or the prompts should be removed.
@ghost
Copy link
Author

ghost commented Sep 18, 2020

i think prompts should be removed.

@tesuji
Copy link
Contributor

tesuji commented Sep 18, 2020

I agree the prompts ($ or >) aren't always needed in case we don't have sample command output.
Pull requests welcomed to remove them.

@rustbot modify labels: T-doc C-enhancement E-easy

@rustbot rustbot added C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools labels Sep 18, 2020
@ghost ghost mentioned this issue Sep 18, 2020
Merged
@whizsid
Copy link
Contributor

whizsid commented Sep 19, 2020

I like to work on this issue.

@tesuji
Copy link
Contributor

tesuji commented Sep 20, 2020

Sorry, there's already an open PR: #76883

@jyn514 jyn514 assigned ghost Sep 20, 2020
RalfJung added a commit to RalfJung/rust that referenced this issue Sep 20, 2020
@RalfJung
Rollup merge of rust-lang#76883 - qlcom:master, r=Mark-Simulacrum
ba7142b 
README.md: Remove prompts from code blocks

rust-lang#76863
RalfJung added a commit to RalfJung/rust that referenced this issue Sep 20, 2020
@RalfJung
Rollup merge of rust-lang#76883 - qlcom:master, r=Mark-Simulacrum
3ef093b 
README.md: Remove prompts from code blocks

rust-lang#76863
@ghost ghost closed this as completed Sep 20, 2020
@p8 p8 mentioned this issue May 31, 2022
Merged
9 tasks
This issue was closed.
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools C-enhancement Category: An issue proposing an enhancement or a PR with one. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tesuji @whizsid @rustbot