search

melexis / sphinx-coverity-extension

Sphinx plugin to generate Coverity defects report or table in reStructuredText documentation. Coverity report is then personally styled while data integrity is guaranteed.
GNU General Public License v3.0
5 stars 2 forks source link

Update readme #29

Closed JasperCraeghs closed 5 years ago

JasperCraeghs commented 5 years ago

Add :chart: option to readme, clarify the optional :col: option. Fix: The :widths: option was called width in readme and missing from the Syntax in CoverityDefectListDirective. Clarify that its parameters are to be space-separated, instead of the usual comma-separation. Add mlx.traceability to example/pip-dependencies.txt, since it is used in example/conf.py.

Closes #20

codecov-io commented 5 years ago

Codecov Report

Merging #29 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #29   +/-   ##
======================================
  Coverage    14.8%   14.8%           
======================================
  Files           1       1           
  Lines         304     304           
======================================
  Hits           45      45           
  Misses        259     259
Impacted Files Coverage Δ
mlx/coverity.py 14.8% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 2f7b3bc...25443ac. Read the comment docs.

JasperCraeghs commented 5 years ago

@Letme I've added some last-minute changes regarding the widths option.