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

In the README.rst file, the statement above the command prompt should be an example specific to Python #2551

Closed
RohanVB opened this issue Jul 24, 2016 · 5 comments

Comments

@RohanVB
Copy link
Member

RohanVB commented Jul 24, 2016

The current command prompt is displayed as :

To see what coala can do for your language, run:

$ coala --show-bears --filter-by-language Python

Since we are giving an example, the statement above the command prompt should be specific to Python.

@gitmate-bot
Copy link
Collaborator

Thanks for reporting this issue! A coalaian will look at it soon.

@sils
Copy link
Member

sils commented Jul 24, 2016

Isn't that obvious? I feel like an example with a real language is more useful than "insert language". Not that I'm sure...

@RohanVB
Copy link
Member Author

RohanVB commented Jul 24, 2016

It's obvious, but I don't feel its correct. If python has to be in the prompt, the sentence above should be an example specific to using it with terminal, making it 'For example, to see what coala can do with Python, run:' Because right now one is generalised, the other is specific.

@sils
Copy link
Member

sils commented Jul 24, 2016

cool so let's change the explanation above?

@RohanVB RohanVB changed the title In the README.rst file, the command prompt to see what coala can do should be generalized. In the README.rst file, the statement above the command prompt should be an example specific to Python Jul 24, 2016
@Adrianzatreanu
Copy link
Contributor

This issue was moved to coala/documentation#24

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

No branches or pull requests

4 participants