Skip to content
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

Added Shell Autocompletion feature in Installation guide #390

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Users/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,14 @@ For x86 python or for x64 python:

Replace "XXX" with the ClangSharp version you received from nuget.


Integrating Shell Autocompletion

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (112 > 79)

LineLengthBear, severity NORMAL, section docs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (112 > 79)

LineLengthBear, severity NORMAL, section docs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line is longer than allowed. (112 > 79)

LineLengthBear, severity NORMAL, section docs.

--------------------------------

You can also use coala for tab completion in bash or zsh. This will autocomplete coala arguments and bear names.
You can set them up `here <http://coala.readthedocs.io/en/stable/Users/Tutorials/Shell_Autocompletion.html>`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tutorials/Shell_Autocompletion is an internal documentation that can be cross-referenced using sphinx role :doc: as described here: http://www.sphinx-doc.org/en/1.5.1/markup/inline.html#role-doc

Can you try doing that, instead of using an external link?

( http://coala.readthedocs.io/en/stable/Users/Tutorials/Shell_Autocompletion.html is considered an external link )

Perhaps also rephrase this to:

You can set them up by following this tutorial. (tutorial as hyperlink)

After that, please use squash all of your commits into one.
Instructions for squashing commits are here:
http://api.coala.io/en/latest/Developers/Git_Basics.html#squashing-your-commits

Thanks.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Mariatta and @hemangsk I'll look into it


Copy link
Member

@hemangsk hemangsk Jan 12, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L287 & L288 have length ~ 112, so you can try moving stuff from these lines to new lines so that it stays in length limit ie (79)
😃 👍

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okk sure, thanks!


Installation Errors
-------------------

Expand Down