search

rob-smallshire / cartouche

A Sphinx extension to convert help() friendly docstrings to Sphinx markup
BSD 3-Clause "New" or "Revised" License
5 stars 3 forks source link

cartouche not parsing multi-line exception syntax #11

Closed rob-smallshire closed 11 years ago

rob-smallshire commented 11 years ago

Original author: serged...@gmail.com (October 17, 2012 19:47:13)

What steps will reproduce the problem?

  1. Include the following as the docstring for a method: """ Raises: Exception: This is a multi-line bug. """
  2. Try to build the documentation with sphinx-build

What is the expected output? What do you see instead?

Expected: build without errors.

Actual: Extension error: Invalid cartouche exception syntax

What version of the product are you using? On what operating system?

Sphinx v1.1.3 cartouche v0.9 CentOS release 6.3 (Final)

Please provide any additional information below.

n/a

Original issue: http://code.google.com/p/cartouche/issues/detail?id=11

thezerobit commented 11 years ago

I couldn't reproduce this. Seems to work fine, as long as "Raises:" is not the first line, if it is, it doesn't get converted properly, no error, though. Doesn't seem like a bug.

rob-smallshire commented 11 years ago

I can't reproduce this either. I've added a test for it in any case in test_issues.py.

The supplies doctoring isn't what Cartouche is expecting anyway. Each exception entry should be indented one level with respect to the Raises: heading.