action #51413
open
coordination #50507: [qe-core][functional][saga] document lib/ functions
[qe-core][functional] Automatic checks for missing documentation in /lib
Added by SLindoMansilla almost 5 years ago.
Updated about 1 month ago.
Target version:
SUSE QA - Milestone 30
Description
- AC: It is ensured, that everyone adding new functionality also documents it
Tasks¶
- Create a mechanism that runs pod-checker and shows a list of undocumented functions under /lib
- PR are not able to be merged if the check doesn't pass (or is below under a certain threshold)
Suggestions¶
- Take into account situations where routines/function are so small that don't need documentation,
##nodoc could be an option to indicate the parser, that the following method doesn't need to be checked.
- Document methods in /lib where it would be useful.
- Figure and propose a podchecker documentation format (and use that script to for the automated checks on travis) (see poo#50510)
- Status changed from Workable to In Progress
- Assignee set to jorauch
- Target version changed from Milestone 25 to Milestone 26
In my understanding podchecker is not feasible for this task, as it only checks if the syntax of the given pod file is correct or if the file contains POD at all.
we could reuse one of my old hackweek projects, as a script to check if every function contains documentation
- Status changed from In Progress to Workable
we still need a decision here
- Status changed from Workable to Feedback
Putting in the feedback queue for discussion reasons
For checking missing documentation of particular functions inside a file taking into account that there are functions that don't need to be documented. (##nodoc)
Check documentation coverage.
- Target version changed from Milestone 26 to Milestone 27
@ jojo, let's discuss status here once you're back from vacation
- Target version changed from Milestone 27 to Milestone 28
- Assignee changed from jorauch to SLindoMansilla
We should discuss this sometimes
- Target version changed from Milestone 28 to Milestone 30
needs to be discussed offline
- Status changed from Feedback to New
- Assignee deleted (
SLindoMansilla)
- Description updated (diff)
- Category changed from Enhancement to existing tests to Spike/Research
- Start date deleted (
2019-05-13)
The task was groomed online a bit, but at the moment there seems to be no clear picture for this task still, so we can pick it up later on.
- Description updated (diff)
- Subject changed from [functional][u] Automatic checks for missing documentation in /lib to [qe-core][functional] Automatic checks for missing documentation in /lib
This ticket was set to Normal priority but was not updated within the SLO period. Please consider picking up this ticket or just set the ticket to the next lower priority.
This ticket was set to Normal priority but was not updated within the SLO period. Please consider picking up this ticket or just set the ticket to the next lower priority.
Also available in: Atom
PDF