We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Describe the bug:
When a fenced code block includes a doctest test (specifically >>> prompts), the generated markdown is incorrect.
>>>
Expected behaviour:
Fenced code blocks containing >>> should render just like any other fenced code block.
For example, this docstring:
"""Compute the sum of 2 numbers. Examples: ```plain >>> add(1, 2) 3 >>> add(2, 2) 4 ``` """
should generate the following markdown:
Compute the sum of two numbers. **Examples:** ```plain >>> add(1, 2) 3 >>> add(2, 2) 4 ```
Unfortunately, it produces the following instead:
Compute the sum of two numbers. **Examples:** ```plain ``` add(1, 2)``` 3 ``` add(2, 2)``` 4 ```
And the resulting HTML does not render as expected.
Steps to reproduce the issue:
See example docstring above.
Technical details:
Possible Fix:
I have not looked at the lazydocs code, so I don't know, but happy to dig in, if it would help.
Additional context:
None
The text was updated successfully, but these errors were encountered:
Hmmm, I just discovered this: https://github.com/ml-tooling/lazydocs/blob/v0.4.8/src/lazydocs/generation.py#L366-L368
At first glance, this appears to be incorrect, but I'll investigate further.
Sorry, something went wrong.
This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days
No branches or pull requests
Describe the bug:
When a fenced code block includes a doctest test (specifically
>>>
prompts), the generated markdown is incorrect.Expected behaviour:
Fenced code blocks containing
>>>
should render just like any other fenced code block.For example, this docstring:
should generate the following markdown:
Unfortunately, it produces the following instead:
And the resulting HTML does not render as expected.
Steps to reproduce the issue:
See example docstring above.
Technical details:
Possible Fix:
I have not looked at the lazydocs code, so I don't know, but happy to dig in, if it would help.
Additional context:
None
The text was updated successfully, but these errors were encountered: