Skip to content
This repository has been archived by the owner on Aug 8, 2023. It is now read-only.

Remove $ symbol from code blocks #375

Closed
shalier opened this issue May 24, 2022 · 4 comments · May be fixed by #392
Closed

Remove $ symbol from code blocks #375

shalier opened this issue May 24, 2022 · 4 comments · May be fixed by #392
Assignees
@Santosh1176

Comments

@shalier
Copy link
Contributor

shalier commented May 24, 2022 •
edited
Loading

Some code blocks have the $ in front of the command such that when you copy the block it'll copy the $ as well so then the command doesn't run
image
@shalier
Copy link
Contributor Author

shalier commented May 24, 2022

This could be fixed with #374, it looks like the $ is used to separate the command from the example output. But not entirely sure that #374 covers every instance of a code block having a $

@Santosh1176
Copy link

Hey, Can I take this up?

@Santosh1176
Copy link

Thanks, @shalier. Do you want me to remove all instances of $ and # from the docs or is there any specific set of docs where this needs to be done?

@shalier
Copy link
Contributor Author

shalier commented Jun 21, 2022

@Santosh1176 Removing all instances of $ should be enough since that actively affects the copied code.
# shouldn't affect the copied code so we're good to leave it.
I didn't have a specific set of docs in mind, but I think anywhere that we have copyable code should be looked at.

Thanks for working on this!

@Santosh1176 Santosh1176 mentioned this issue Jun 22, 2022
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@Santosh1176 Santosh1176

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Removed $ symbol from code blocks in the Docs Santosh1176/osm-docs
3 participants
@phillipgibson @shalier @Santosh1176