Distinguish between docstrings and comments

zsol / py.wtf

Autogenerated reference docs for PyPI packages

https://py.wtf

MIT License

10 stars 3 forks source link

Open zsol opened 2 years ago

zsol commented 2 years ago

Currently for a function like this:

# foo
def bar():
  # lol
  """my docstring"""

The generated documentation will look like:

("foo", "lol", "my docstring")

This is suboptimal, we want my docstring to display prominently, but also keep foo and lol somewhere.

zsol commented 2 years ago

Also:

we should never expect to parse comments as restructured text (or any kind of markup for that matter)
maybe consider removing shebangs
block comments should be grouped into one string so they can get displayed as one block rather than a <pre> per line
highlight comments differently from docstrings in www. (slightly dimmed and italic?)