sphinx-contrib / napoleon

Other
148 stars 48 forks source link

Fix output for multi-line and multi-parameter return/yield strings #15

Closed baylessj closed 5 years ago

baylessj commented 5 years ago

Closes #12.

The output of multi-line return and yield statements can end up garbled and showing as bulletted lists when they shouldn't be. #12 captures one example of this, but I found that other methods of documenting the return values can cause similar errors.

Currently opening this as a draft, I would appreciate any critiques of the test cases that I am adding as I progress; I'll work on making sure that all of the test cases pass once it's clear that I'm testing for the right conditions/correct output.