chevah / compat

Chevah OS Compatibility Layer
Other
4 stars 1 forks source link

Improve linter - force creating a new line after a full stop and space #267

Closed chevah-robot closed 6 years ago

chevah-robot commented 7 years ago

T4044 task was created by hcs on 2017-05-03 09:48:25Z. Last changed on 2018-09-21 09:24:34Z. PR at https://github.com/chevah/scame/pull/7.

This will help in enforcing semantic linefeeds

http://styleguide.chevah.com/documentation.html#semantic-linefeeds

chevah-robot commented 7 years ago

Comment by adiroiban at 2017-05-03 12:51:15Z.

Are you working on this? If yes, then it should be put for next-release milestone.

We might want to rename next-release to current-sprint or ongoing-milestone to make it clear that is the milestone used to track the in-work / present tasks.

Let me know if you need help with implementing this... the checker should be done in pocket-lint --- there is branch for our project https://github.com/chevah/pocket-lint/tree/chevah-master

here is the RST checker https://github.com/chevah/pocket-lint/blob/chevah-master/pocketlint/formatcheck.py#L979

and later we can look at applying the same check for any docstring.

chevah-robot commented 7 years ago

Comment by hcs at 2017-05-03 17:07:39Z.

Replying to adi:

Are you working on this? If yes, then it should be put for next-release milestone.

We might want to rename next-release to current-sprint or ongoing-milestone to make it clear that is the milestone used to track the in-work / present tasks.

Let me know if you need help with implementing this... the checker should be done in pocket-lint --- there is branch for our project https://github.com/chevah/pocket-lint/tree/chevah-master

here is the RST checker https://github.com/chevah/pocket-lint/blob/chevah-master/pocketlint/formatcheck.py#L979

and later we can look at applying the same check for any docstring.

Thanks. This is a nice-to-have feature and a good way to learn more about how lint checking works.

chevah-robot commented 7 years ago

Comment by hcs at 2017-05-10 22:06:07Z.

Make sure the following do not get caught up:

Adnotations like: .. warning::

(two spaces, two ..)

chevah-robot commented 7 years ago

Comment by hcs at 2017-05-17 17:10:15Z.

Issue:

To create an sftpplus group and a corresponding user on OS X, replace the value of 240 from the following example with a unique ID for your system::

# Create the group dedicated to the service account.
dscl . create /Groups/sftpplus
chevah-robot commented 7 years ago

Comment by hcs at 2017-07-07 14:50:39Z.

paver lint --all result https://github.com/chevah/scame/issues/5

Will look into this in another session

chevah-robot commented 7 years ago

Comment by pqm at 2017-07-07 22:39:41Z.

hcs requested the review of this ticket.

needs-review

chevah-robot commented 7 years ago

Comment by pqm at 2017-07-10 08:08:00Z.

adi needs-changes to this ticket.

Looks good.

Please extend the test to also cover valid use cases, not only the negative tests.

You should have write access to the repo, so feel free to create a branch directly into this repo.. and not into a fork.

also, please merge into master branch and not trunk. Since moving to 'scamewe now usemaster` as te main branch.

great work!

chevah-robot commented 7 years ago

Comment by pqm at 2017-08-23 12:32:27Z.

hcs requested the review of this ticket.

needs-review

chevah-robot commented 7 years ago

Comment by adiroiban at 2017-08-31 13:46:51Z.

this needs to be on the next-release as otherwise, it will get a very low priority in the work items

chevah-robot commented 7 years ago

Comment by hcs at 2017-08-31 14:13:30Z.

thanks. it's up for another review (in a new PR to change branches)

chevah-robot commented 7 years ago

Comment by pqm at 2017-08-31 14:42:57Z.

adi needs-changes to this ticket.

see my final comment

chevah-robot commented 7 years ago

Comment by pqm at 2017-09-12 16:36:27Z.

adi needs-changes to this ticket.

please check latest commits.

I have fixed all the other tests, so the remaining tests which are failing are the one for this branch.


I don't really understand what your code and your test is trying to do :(

I have replaced it with a basic implementation, which works for one test (test_check_semantic_newline_fullstop)

you can target a single test using

build/bin/nosetests scame.tests.test_restructuredtext:TestReStructuredTextChecker.test_check_semantic_newline_questionmark
chevah-robot commented 6 years ago

Comment by hcs at 2018-09-21 09:24:34Z.

I'll close this as not much work has been done and this can be checked via manual reviews