-
-
Notifications
You must be signed in to change notification settings - Fork 72
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
[docs] Documents openwisp-utils-qa-checks #47 #65
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Rebase with master.
master
containsopenwisp-utils-qa-checks
section. Improve on that.- Please document all the options as well. (for all the
openwisp-utils-qa-checks
as well, likecommitcheck
,migration name check
) You'll have to read some of the code for that as well!
@atb00ker Ah I see, it must’ve been added after I made my commit (was away for a few days so couldn’t push immediately) |
Some options are not documented, please read the code & testcases for all the tests, it should help you find out, when you think you've found all of them, mark for review and I'll double check to let you know! 😄 |
b44f619
to
c23205d
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, it's going good.
Please see the comments below.
README.rst
Outdated
The following quality assurance checks are ran in openwisp-utils-qa-checks: | ||
|
||
* ``checkmigrations`` (Read more below) | ||
* ``checkcommit`` (Read more below) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line "Simulation of a special unplanned case\n\n#noqa" shows an undocumented change. Please document #noqa
case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@atb00ker Could you explain what you mean here? I believe the #noqa
case is documented above?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please send the link?
f756ec8
to
6f09481
Compare
This commit adds openwisp-utils-qa-checks to the README file and describes its purpose. It also includes checkendline Fixes openwisp#47
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@atb00ker is this ready to merge?
Adds openwisp-utils-qa-checks to the README file and describes its purpose. It also includes
checkendline
Fixes #47