Skip to content

Parsing bug on triple quotes #108

Open

Description

@turicas

Hi! First of all, thanks for creating this project. :)

I've found a parsing bug related to triple quotes. This is how to reproduce:

If I create a file named test.py with the following contents:

def test():
    """this is a test
    this line will break parsing because triple quotes finish here, not the next line."""
    pass

Then, run:

pycco test.py

And open docs/test.html in the browser, I'll get:

pycco-parsing-bug

If I change the file to:

def test():
    """this is a test
    this line will break parsing because triple quotes finish here, not the next line.
    """
    pass

Then the output will be:

pycco-parsing-2

Activity

  1. gabpalves commented on Feb 21, 2019

    @gabpalves

    Though i agree scenarios like these could also be handled by the application, i don't think this can be technically defined as a bug. The reason is the PEP 257 specifies that:

    Unless the entire docstring fits on a line, place the closing quotes on a line by themselves

    ... and that's the convention Pycco follows.

  2. turicas commented on Feb 21, 2019

    @turicas
    Author

    @gabpalves, the code I've posted as a test to reproduce the bug is valid Python code (it's PEP257-invalid though). I think pycco should work with any (valid) Python code, even if not following the PEP suggestions (they're just suggestions, not a mandatory thing).

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions