Yelp / swagger-spec-compatibility

Python library to check Swagger Spec backward compatibility
https://swagger-spec-compatibility.readthedocs.org
Apache License 2.0
20 stars 8 forks source link

Add documentation link into error reporting #9

Closed macisamuele closed 5 years ago

macisamuele commented 5 years ago

The goal of this PR is to make explicit the link to the documentation page where the reporting is detailed explained.

codecov[bot] commented 5 years ago

Codecov Report

Merging #9 into master will not change coverage. The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master     #9   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          59     59           
  Lines        1780   1808   +28     
  Branches      113    115    +2     
=====================================
+ Hits         1780   1808   +28
Impacted Files Coverage Δ
tests/cli/run_test.py 100% <100%> (ø) :arrow_up:
tests/conftest.py 100% <100%> (ø) :arrow_up:
swagger_spec_compatibility/rules/common.py 100% <100%> (ø) :arrow_up:
tests/rules/common_test.py 100% <100%> (ø) :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 ae28a15...c7df4b7. Read the comment docs.

macisamuele commented 5 years ago

@sjaensch this is now ready for review. As we discussed offline there was a "minor" issue related to the fact that the previous iteration would have provided read-the-docs links for all the rules (even if not implemented in the library) and this would eventually increase confusion)

The new approach does provide: