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

Enable RST linting bears on this repo #432

Closed
Mixih opened this issue Apr 5, 2017 · 8 comments · Fixed by #438
Closed

Enable RST linting bears on this repo #432

Mixih opened this issue Apr 5, 2017 · 8 comments · Fixed by #438

Comments

@Mixih
Copy link
Member

Mixih commented Apr 5, 2017

Currently, this repository is not being linted for rst problems. Please enable both reSTLintBear and RSTCheckBear. There are probably issues with the rst which need fixing first. Please spawn newcomer sub-issues for each one found, or fix them yourself.

@mridubhatnagar
Copy link

Hey, I went through
1)http://docs.coala.io/en/latest/Users/Tutorial.html .
2) Went through .coafile

Can you guide me how to proceed further. So that I can make some progress and help in resolving this issue.

@Mixih
Copy link
Member Author

Mixih commented May 7, 2017

see the rst section int he main coala repo for some inspiration. You probably want both reSTLintBEar and RSTCheckBEar.

@mridubhatnagar
Copy link

mridubhatnagar commented May 8, 2017

Went through rst section, .coafile in the main coala repo. Seems reSTLintBear is already present in .coafile.
do I just need to add RSTCheckBear.
And files=docs/**/.rst .

mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enabled both reSTLintBear and RSTCheckBear in the .coafile
present in the documentation repo.

closes coala#432
@mridubhatnagar
Copy link

Please can someone look into this commit. And tell me regarding the needful changes before I raise a final PR. Changes other than the newline that needs to be added.

mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enabled both reSTLintBear and RSTCheckBear in the .coafile
present in the documentation repo.

closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enable both reSTLintBear and RSTCheckBear by .coafile
present in this repo.

closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enable both reSTLintBear and RSTCheckBear by .coafile
present in this repo.

closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enable both reSTLintBear and RSTCheckBear by .coafile
present in this repo.

Closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 8, 2017
Enable both reSTLintBear and RSTCheckBear by .coafile
present in this repo.

Closes coala#432
@jayvdb
Copy link
Member

jayvdb commented May 9, 2017

@Mixih , @mridubhatnagar , @SanketDG , in light of coala/coala-bears#1716 , why do we want to enable both reSTLintBear and RSTCheckBear. What advantages are their for using reSTLintBear ? Does it show errors that RSTCheckBear doesnt show?

RSTCheckBear already solves these problems ( rstcheck/rstcheck#1 ) with config like:

[rstcheck]
ignore_directives=one,two,three
ignore_roles=src,RFC

@SanketDG
Copy link
Member

SanketDG commented May 9, 2017

@jayvdb I just ran stuff on two bears, and it looks like rstcheck has sphinx support by default, so it reports none of those, there is not even config file needed!

@mridubhatnagar please remove reSTLintBear and only use RSTCheckBear 👍

@mridubhatnagar
Copy link

Sure, Thanks . Shall do it by today.

@mridubhatnagar
Copy link

mridubhatnagar commented May 9, 2017

If I keep just the RSTcheckBear. Title underline too short error stems up. Even after changing the length of underline. I am using python 3.4.2.

mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 9, 2017
Enable RSTCheckBear by .coafile
present in this repo.

Closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 9, 2017
Enable RSTcheckBear by .coafile
present in this repo.

Closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 9, 2017
Enable RSTcheckBear by .coafile
present in this repo.

Closes coala#432
mridubhatnagar pushed a commit to mridubhatnagar/documentation that referenced this issue May 9, 2017
Enable RSTcheckBear by .coafile
present in this repo.

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

Successfully merging a pull request may close this issue.

5 participants