some invalid epytext markup is not reported as such

Bug #288181 reported by Jean-Paul Calderone
2
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.nevowhtml.writer.NevowWriter
  starting ModuleIndexPage ... took 0.038186s
  starting ClassIndexPage ... took 0.002309s
  starting IndexPage ... took 0.007698s
  starting NameIndexPage ... took 0.007809s
  starting UndocumentedSummaryPage ... took 0.003291s
  3/3 pages written
  exarkun@charm:~$

Changed in pydoctor:
status: New → Triaged
importance: Undecided → Medium
Revision history for this message
Michael Hudson-Doyle (mwhudson) wrote :

This is a bit related to #960709 I guess.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.