Project

General

Profile

Actions

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 9 days ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Spike/Research
Target version:
SUSE QA - Milestone 30
Start date:
Due date:
% Done:

0%

Estimated time:
Difficulty:

Description

AC

  • AC: It is ensured, that everyone adding new functionality also documents it

Tasks

  1. Create a mechanism that runs pod-checker and shows a list of undocumented functions under /lib
  2. PR are not able to be merged if the check doesn't pass (or is below under a certain threshold)

Suggestions

  1. 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.
  2. Document methods in /lib where it would be useful.
  3. Figure and propose a podchecker documentation format (and use that script to for the automated checks on travis) (see poo#50510)
Actions #1

Updated by jorauch over 4 years ago

  • Status changed from Workable to In Progress
  • Assignee set to jorauch
Actions #2

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 25 to Milestone 26
Actions #3

Updated by jorauch over 4 years ago

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.

Actions #4

Updated by jorauch over 4 years ago

we could reuse one of my old hackweek projects, as a script to check if every function contains documentation

Actions #5

Updated by jorauch over 4 years ago

  • Status changed from In Progress to Workable

we still need a decision here

Actions #6

Updated by jorauch over 4 years ago

  • Status changed from Workable to Feedback

Putting in the feedback queue for discussion reasons

Actions #7

Updated by SLindoMansilla over 4 years ago

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.

Actions #8

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 26 to Milestone 27

@ jojo, let's discuss status here once you're back from vacation

Actions #9

Updated by mgriessmeier over 4 years ago

  • Target version changed from Milestone 27 to Milestone 28
Actions #10

Updated by jorauch over 4 years ago

  • Assignee changed from jorauch to SLindoMansilla

We should discuss this sometimes

Actions #11

Updated by mgriessmeier about 4 years ago

  • Target version changed from Milestone 28 to Milestone 30

needs to be discussed offline

Actions #12

Updated by SLindoMansilla about 4 years ago

  • Status changed from Feedback to New
  • Assignee deleted (SLindoMansilla)
Actions #13

Updated by szarate over 3 years ago

  • 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.

Actions #14

Updated by szarate over 3 years ago

  • Description updated (diff)
Actions #15

Updated by tjyrinki_suse over 3 years ago

  • Subject changed from [functional][u] Automatic checks for missing documentation in /lib to [qe-core][functional] Automatic checks for missing documentation in /lib
Actions #16

Updated by okurz over 2 years ago

I came to this ticket due to periodically reviewing tickets as described on https://progress.opensuse.org/projects/openqatests/wiki#How-we-work-on-tickets

This ticket was set to "Normal" priority but was not updated within the SLO period for "Normal" tickets (365 days) as described on https://progress.opensuse.org/projects/openqatests/wiki/Wiki#SLOs-service-level-objectives

First reminder: Please consider picking up this ticket within the next 365 days or just set the ticket to the next lower priority of "Low" (no SLO related time period).

Actions #17

Updated by slo-gin over 1 year ago

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.

Actions #18

Updated by slo-gin 9 days ago

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.

Actions

Also available in: Atom PDF