some invalid epytext markup is not reported as such
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pydoctor |
Triaged
|
Medium
|
Unassigned |
Bug Description
If a function's docstring includes epytext markup documenting a parameter which the function does not have, pydoctor doesn't seem to consider this an error. It generates output which includes the documentation for the parameter without emitting a warning or error.
eg
exarkun@charm:~$ mkdir foo
exarkun@charm:~$ touch foo/__init__.py
exarkun@charm:~$ cat > foo/foo.py
def bar(baz):
"""
@param quux: foo
"""
exarkun@charm:~$ pydoctor --make-html --add-package foo/
adding directory /home/exarkun/foo
2/2 modules processed 0 warnings
WARNING: guessing foo for project name
writing html to apidocs using pydoctor.
starting ModuleIndexPage ... took 0.038186s
starting ClassIndexPage ... took 0.002309s
starting IndexPage ... took 0.007698s
starting NameIndexPage ... took 0.007809s
starting UndocumentedSum
3/3 pages written
exarkun@charm:~$
Changed in pydoctor: | |
status: | New → Triaged |
importance: | Undecided → Medium |
This is a bit related to #960709 I guess.