Documentation Coverage

Filename

Total

Covered

Missing

Coverage in %

📦pyTooling

0

0

0

-100.0%

 📦Attributes

15

10

5

66.7%

  📦ArgParse

27

20

7

74.1%

     Argument

26

25

1

96.2%

     BooleanFlag

5

0

5

0.0%

     Flag

7

2

5

28.6%

     KeyValueFlag

7

2

5

28.6%

     OptionalValuedFlag

7

2

5

28.6%

     ValuedFlag

7

2

5

28.6%

 📦CLIAbstraction

34

10

24

29.4%

    Argument

59

53

6

89.8%

    BooleanFlag

15

11

4

73.3%

    Command

12

8

4

66.7%

    Flag

12

5

7

41.7%

    KeyValueFlag

16

7

9

43.8%

    OptionalValuedFlag

17

7

10

41.2%

    ValuedFlag

13

9

4

69.2%

    ValuedFlagList

18

12

6

66.7%

    ValuedTupleFlag

10

4

6

40.0%

 📦CallByRef

46

46

0

100.0%

 📦Cartesian2D

43

33

10

76.7%

    Shapes

8

8

0

100.0%

 📦Cartesian3D

43

33

10

76.7%

    Volumes

4

2

2

50.0%

 📦Common

25

15

10

60.0%

 📦Configuration

20

10

10

50.0%

    JSON

32

13

19

40.6%

    YAML

32

13

19

40.6%

 📦Decorators

14

7

7

50.0%

 📦Exceptions

13

9

4

69.2%

 📦Filesystem

84

35

49

41.7%

 📦GenericPath

14

8

6

57.1%

    URL

23

17

6

73.9%

 📦Graph

153

128

25

83.7%

    GraphML

101

7

94

6.9%

 📦Licensing

17

16

1

94.1%

 📦LinkedList

38

36

2

94.7%

 📦MetaClasses

36

17

19

47.2%

 📦Packaging

23

23

0

100.0%

 📦Platform

32

24

8

75.0%

 📦StateMachine

10

4

6

40.0%

 📦Stopwatch

34

28

6

82.4%

 📦TerminalUI

80

60

20

75.0%

 📦Tree

54

51

3

94.4%

 📦Versioning

99

74

25

74.7%

 📦Warning

7

1

6

14.3%

Overall (46 files):

934

678

256

72.6%

Documentation Coverage

Coverage Level

≤10 %

almost undocumented

≤20 %

almost undocumented

≤30 %

almost undocumented

≤40 %

poorly documented

≤50 %

poorly documented

≤60 %

roughly documented

≤70 %

roughly documented

≤80 %

roughly documented

≤85 %

well documented

≤90 %

well documented

≤95 %

well documented

≤100 %

excellent documented

Documentation coverage generated with docstr-coverage and visualized by sphinx-reports.