You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I don't know if it's "expected" behavior per say, of feature/change request.
I'd like a way to have ReferenceWarning: Code reference mymodule.erroneous_reference in module "mymodule" does not match any documented object. be an error, so that my CI action catches this sort of problem.
Currently, it seems only import errors are considered "errors", as per --skip-error. I would expect that erroneous references should be errors as well, that can be downgraded to warning using --skip-error.
I can do a quick PR if that's ok with you :)
Actual Behavior
deftest() ->"mymodule.erroneous_reference":
pass
or
deftest():
"""Hello world Returns: mymodule.erroneous_reference """pass
gives ReferenceWarning: Code reference mymodule.erroneous_reference in module "mymodule" does not match any documented object.
which is a warning, regardless if skip-errors is set.
Steps to Reproduce
deftest() ->"mymodule.erroneous_reference":
pass
Additional info
pdoc version: latest, master
The text was updated successfully, but these errors were encountered:
Expected Behavior
I don't know if it's "expected" behavior per say, of feature/change request.
I'd like a way to have
ReferenceWarning: Code reference mymodule.erroneous_reference in module "mymodule" does not match any documented object.
be an error, so that my CI action catches this sort of problem.Currently, it seems only import errors are considered "errors", as per
--skip-error
. I would expect that erroneous references should be errors as well, that can be downgraded to warning using--skip-error
.I can do a quick PR if that's ok with you :)
Actual Behavior
or
gives
ReferenceWarning: Code reference mymodule.erroneous_reference in module "mymodule" does not match any documented object.
which is a warning, regardless if skip-errors is set.
Steps to Reproduce
Additional info
The text was updated successfully, but these errors were encountered: