Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG: `Args` section issue when variable name is single upper case character #14

Closed
wq2012 opened this issue Jan 28, 2019 · 1 comment

Comments

2 participants
@wq2012
Copy link
Contributor

commented Jan 28, 2019

Expected Behavior

I have this docstring:

def compute_intersection_length(A, B):
    """Compute the intersection length of two tuples.
    Args:
        A: a (speaker, start, end) tuple of type (string, float, float)
        B: a (speaker, start, end) tuple of type (string, float, float)
    Returns:
        a float number of the intersection between `A` and `B`
    """

I expect the generated docs separate A and B in different paragraphs.

Actual Behavior

This is what has been generated:
screenshot from 2019-01-28 11-00-05

Not sure if this is a bug or intentional...

Steps to Reproduce

N/A

Additional info

  • pdoc version:
    master of this repo

@kernc kernc closed this in 7500791 Jan 28, 2019

@kernc

This comment has been minimized.

Copy link
Contributor

commented Jan 28, 2019

Certainly wasn't intentional. The regex was made to recognize beginnings of sections by a preceding empty line. I guess that limitation was superfluous. Hope this doesn't creep in too many false positives ...

Thanks!

@kernc kernc added the bug label Jan 28, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.