fix: Minor docs changes #353
Conversation
There was a problem hiding this comment.
Hi @Aju100 , Thank you for digging through the documentation and creating this PR. I think it would be better if they are converted to code blocks instead. Code blocks will provide syntax highlighting along with formatting hence serving our purpose.
I have added some comments below do have a look.
docs/source/installation.rst
Outdated
|
|
||
| $ pip install fury | ||
| pip install fury | ||
|
|
There was a problem hiding this comment.
remove the :: in the previous line and replace the command with:
.. code-block:: shell
pip install fury
For more info visit here
There was a problem hiding this comment.
thank you @Nibba2018 got to learn about rst too. I request you to have a review and some feedbacks about it
docs/source/installation.rst
Outdated
| export DISPLAY=:0 | ||
| Xvfb :0 -screen 1920x1080x24 > /dev/null 2>1 & | ||
| pytest -svv fury | ||
|
|
||
| - Second option:: | ||
|
|
There was a problem hiding this comment.
Same as above and for the rest of the shell commands.
There was a problem hiding this comment.
I have done as you can review out my latest commit.
There was a problem hiding this comment.
Thank you for this @Aju100 and thanks for the review @Nibba2018.
Overall, it looks good to me. I just need to generate this locally and then I will go ahead and merge it. Thank you @Aju100
Hi Opensource team,
As the discussion goes on discord group, I had made PR for it where I removed $ in order to execute commands on the terminal.
Regards,
Aju Tamang