Skip to content

Remove $ before shell commands in docs #4698

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.

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

Closed
davidfischer opened this issue Oct 1, 2018 · 11 comments
Closed

Remove $ before shell commands in docs #4698

davidfischer opened this issue Oct 1, 2018 · 11 comments
Labels
Good First Issue Good for new contributors
Milestone

Comments

@davidfischer
Copy link
Contributor

The developers have a preference to not have a $ before shell commands in the docs. This makes it easier to copy and paste from our docs. We should remove it everywhere. The following command should show it everywhere.

grep -Ri "    $ " docs/*.rst docs/*/*.rst
@davidfischer davidfischer added the Good First Issue Good for new contributors label Oct 1, 2018
@davidfischer davidfischer added this to the Documentation milestone Oct 1, 2018
@houllette
Copy link

houllette commented Oct 1, 2018

@davidfischer I can take a stab at this!

EDIT: Pull request is in for this issue

@dojutsu-user
Copy link
Member

@davidfischer is this still open? I would like to take this issue up.

@davidfischer
Copy link
Contributor Author

davidfischer commented Oct 6, 2018

I think #4699 is almost there and there's just a few things left. I think @houllette can finish it up.

@himanshuc3
Copy link

Is this issue closed. I am looking for a beginner issue!

@stsewd
Copy link
Member

stsewd commented Oct 17, 2018

This issue is already taken, there is a PR opened #4699

@himanshuc3
Copy link

OK. I would like to take any beginner issues but most of them have open PRs on them. I'll figure something else out i guess.

@RichardLitt
Copy link
Member

@himanshuc3 If you can't find any that are open, let us know. We can probably make some more.

@rajgoesout
Copy link

Can I take up this issue?

@stsewd
Copy link
Member

stsewd commented Nov 5, 2018

@rajdeepbharati sorry, there is an open PR already #4699

@championballer
Copy link

@RichardLitt It would be great if some good first time issues can be introduced for the project.

@stsewd
Copy link
Member

stsewd commented Nov 18, 2018

There are, but some are already taken https://github.com/rtfd/readthedocs.org/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22, we try to label introductory issues with that label. When watching the repo GitHub show issues on your "timeline/dashboard" when they are labeled.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Issue Good for new contributors
Projects
None yet
Development

No branches or pull requests

8 participants