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

Already on GitHub? Sign in to your account

Docstrings should be dedented #81

Open
anntzer opened this Issue Jan 11, 2012 · 0 comments

Comments

Projects
None yet
1 participant

anntzer commented Jan 11, 2012

Consider the following example:

(defn f
  "A docstring

  - a list
  - another element

  Rest of the docstring."
  (function contents))

The markdown parser sees that the last line of the docstring is indented, so believes that it is part of the second element of the list. Instead, I think the parser should first remove two leading spaces from each line of the docstring (except the first one) before feeding the result to markdown (à la textwrap.dedent function that Python has).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment