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.

Sign up for GitHub

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

Jump to bottom

[docs] Document openwisp-utils-qa-check #47

Closed
nemesifier opened this issue Dec 10, 2019 · 2 comments · Fixed by #65
Closed

[docs] Document openwisp-utils-qa-check #47

nemesifier opened this issue Dec 10, 2019 · 2 comments · Fixed by #65
Labels
bug docs Documentation related issue
Projects
OpenWISP Contributor's Board

Comments

@nemesifier
Copy link
Member

Add the description of checkendline and openwisp-utils-qa-check to the README, in a similar way to how the other quality assurance scripts are documented.
@nemesifier nemesifier added the bug label Dec 10, 2019
@nemesifier nemesifier added this to To do (general) in OpenWISP Contributor's Board via automation Dec 10, 2019
@nemesifier nemesifier changed the title [docs] Document checkendline and openwisp-utils-qa-check. [docs] Document checkendline and openwisp-utils-qa-check Dec 10, 2019
@atb00ker atb00ker added docs Documentation related issue GCI labels Dec 10, 2019
@nemesifier nemesifier mentioned this issue Dec 18, 2019
Closed
@talha-p
Copy link
Contributor

talha-p commented Dec 22, 2019

Unlike the other individual QA checks, checkendline does not seem to be a command-line tool (https://github.com/openwisp/openwisp-utils/blob/master/setup.py#L35) nor is it in the qa.py file

It only appears in the main openwisp-utils-qa-check file as a check, is this what you want me to document?

@marfgold1 marfgold1 mentioned this issue Dec 23, 2019
Merged
@nemesifier
Copy link
Member Author

@TPath123 you're right, the point of the issue is that we need to document the features and usage of openwisp-utils-qa-check, which has been introduced without being documented.
A bit of documentation has just been added in #60, but we need to add a general description of what it does, its purpose, its features.

@nemesifier nemesifier changed the title [docs] Document checkendline and openwisp-utils-qa-check [docs] Document openwisp-utils-qa-check Dec 23, 2019
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Dec 27, 2019
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
e706e5c 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Dec 27, 2019
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
63fc7d5 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
@talha-p talha-p mentioned this issue Dec 27, 2019
Merged
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Dec 29, 2019
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
b44f619 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Dec 29, 2019
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
c23205d 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Jan 1, 2020
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
7f1536f 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Jan 1, 2020
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
f756ec8 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Jan 1, 2020
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
6f09481 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
talha-p added a commit to talha-p/openwisp-utils that referenced this issue Jan 1, 2020
@talha-p
[docs] Documents openwisp-utils-qa-checks openwisp#47
e43eeda 
This commit adds openwisp-utils-qa-checks to the README file and describes
its purpose. It also includes checkendline

Fixes openwisp#47
OpenWISP Contributor's Board automation moved this from To do (general) to Done Jan 2, 2020
nemesifier added a commit that referenced this issue Jan 2, 2020
@nemesifier
Merge pull request #65 from TPath123/qa-docs
cdcacf5 
[docs] Documents openwisp-utils-qa-checks #47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug docs Documentation related issue
Projects
OpenWISP Contributor's Board
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Documents openwisp-utils-qa-checks #47 talha-p/openwisp-utils
3 participants
@nemesifier @atb00ker @talha-p