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

Install.rst: Add post-Java installation info #269

Closed
wants to merge 1 commit into from
Closed

Install.rst: Add post-Java installation info #269

wants to merge 1 commit into from

Conversation

hit023
Copy link

@hit023 hit023 commented Oct 31, 2016

Asks user to restart the shell after Java is
installed to let coala know about the same.

Closes #259

@gitmate-bot
Copy link

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

@@ -70,6 +70,8 @@ To install coala only (without any bears), you can do:

$ pip3 install coala

If, after installing coala, you install Java (information for downloading Java for all majors OS can be found `here <https://www.java.com/en/download/help/download_options.xml>`_.), you must restart your shell. This is to inform coala that Java has been installed.

Choose a reason for hiding this comment

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

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section docs.

The issue can be fixed by applying the following patch:

--- a/Users/Install.rst
+++ b/Users/Install.rst
@@ -70,7 +70,7 @@

     $ pip3 install coala

-If, after installing coala, you install Java (information for downloading Java for all majors OS can be found `here <https://www.java.com/en/download/help/download_options.xml>`_.), you must restart your shell. This is to inform coala that Java has been installed.        
+If, after installing coala, you install Java (information for downloading Java for all majors OS can be found `here <https://www.java.com/en/download/help/download_options.xml>`_.), you must restart your shell. This is to inform coala that Java has been installed.

 Installing inside a virtualenv

Copy link
Member

Choose a reason for hiding this comment

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

also this line is way too long, why doesn't gitmate catch that as well :/

Copy link
Member

Choose a reason for hiding this comment

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

so I'd make this a note and make the phrasing a bit less complicated, shorter and include reasoning for needing java because a lot of people don't like it, how about something along the lines of:

Be sure to have java installed if you install the coala-bears package. You might need to restart your shell after installing it so coala picks it up. Java is needed for our grammar checking analysis routines.

Asks user to restart the shell after Java is
installed to let coala know about the same.

Closes #259
Install.rst: Add post-Java installation info
.. note::

Make sure that you have **Java** installed if you install the coala-bears package. You might need to restart your shell after installing it so that coala picks it up. Java is needed for our grammar checking analysis routines.

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. (237 > 79)

LineLengthBear, severity NORMAL, section docs.

Install.rst: Add post-Java installation info
.. note::

Make sure that you have **Java** installed if you install the coala-bears package. You might need to restart your shell after installing it so that coala picks it up. Java is needed for our grammar checking analysis routines.

Choose a reason for hiding this comment

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

Line contains following spacing inconsistencies:

  • Trailing whitespaces.

SpaceConsistencyBear, severity NORMAL, section docs.

The issue can be fixed by applying the following patch:

--- a/Users/Install.rst
+++ b/Users/Install.rst
@@ -73,7 +73,7 @@
     Install.rst: Add post-Java installation info
 .. note::

-    Make sure that you have **Java** installed if you install the coala-bears package. You might need to restart your shell after installing it so that coala picks it up. Java is needed for our grammar checking analysis routines.        
+    Make sure that you have **Java** installed if you install the coala-bears package. You might need to restart your shell after installing it so that coala picks it up. Java is needed for our grammar checking analysis routines.

 Installing inside a virtualenv

Install.rst: Add post-Java installation info
.. note::

Make sure that you have **Java** installed if you install the coala-bears package. You might need to restart your shell after installing it so that coala picks it up. Java is needed for our grammar checking analysis routines.
Copy link
Contributor

Choose a reason for hiding this comment

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

i dont think the restart is needed for coala to pick it up, but for the terminal to pick it up. or at least thats how it is when you add something ot the PATH on linux

Copy link
Member

Choose a reason for hiding this comment

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

@Adrianzatreanu But coala reads the java location from $PATH no?

@Adrianzatreanu
Copy link
Contributor

@AbdealiJK no, cib has been staled for 2 months by fabian, i will start working on it again this weekend i think, i dont want to suggest anyone to use it yet :)

@Adrianzatreanu
Copy link
Contributor

also, please fix your gitmate issues, thanks!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

4 similar comments
@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@Mixih
Copy link
Member

Mixih commented Nov 25, 2016

@hi023 status update on this?

@hit023
Copy link
Author

hit023 commented Nov 25, 2016

@Mixih Hey! Could you please assign another contributor for this task? Really wound up in Course work. Sorry about it!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

4 similar comments
@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@gitmate-bot
Copy link

Hey! This pull request hasn't been updated for a while :/ It would be nice if we could get this going again!

@Adrianzatreanu
Copy link
Contributor

closing as requested :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

6 participants