Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

python - multiline string not starting with blank line breaks doc generation #34

Closed
aelse opened this issue Mar 12, 2014 · 1 comment
Closed

Comments

@aelse
Copy link

aelse commented Mar 12, 2014

There's a problem parsing python multiline strings that breaks doc generation for all files being parsed. It happens whether it's a function docstring or just a string defined with """ syntax somewhere in a function.

(tested against current version installed by npm)

def broken():
    """Broken"""
    pass

def broken2():
    also_broken = True
    return """Broken"""

def not_broken():
    """
    Not broken"""
    pass

Output from apidoc when a broken case is present:

apidoc: count blocks: 4
apidoc: count elements in block 0: 0
apidoc: count elements in block 1: 0
apidoc: count elements in block 2: 1
apidoc: count elements in block 3: 1
apidoc: Nothing to do.
aelse added a commit to aelse/apidoc that referenced this issue Mar 12, 2014
@rottmann
Copy link
Member

Thanks, i fix it for the other languages too in 0.4.2.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants