Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distinguish between docstrings and comments #27

Open
zsol opened this issue Aug 11, 2022 · 1 comment
Open

Distinguish between docstrings and comments #27

zsol opened this issue Aug 11, 2022 · 1 comment

Comments

@zsol
Copy link
Owner

zsol commented Aug 11, 2022

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.

@abesto abesto added the indexer label Aug 11, 2022
@zsol zsol added the www label Sep 5, 2022
@zsol
Copy link
Owner Author

zsol commented Sep 5, 2022

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?)

@zsol zsol changed the title Distinguish between docstrings and comments in index Distinguish between docstrings and comments Sep 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants