-
-
Notifications
You must be signed in to change notification settings - Fork 143
Open
Labels
Hacktoberfesthttps://hacktoberfest.digitalocean.comhttps://hacktoberfest.digitalocean.combugSomething isn't workingSomething isn't workingenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wanted 🤷Extra attention is neededExtra attention is needed
Description
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
def test() -> "mymodule.erroneous_reference":
pass
or
def test():
"""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
def test() -> "mymodule.erroneous_reference":
pass
Additional info
- pdoc version: latest, master
kernckernc
Metadata
Metadata
Assignees
Labels
Hacktoberfesthttps://hacktoberfest.digitalocean.comhttps://hacktoberfest.digitalocean.combugSomething isn't workingSomething isn't workingenhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wanted 🤷Extra attention is neededExtra attention is needed