ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
197 stars 38 forks source link

Global variable comment is ignored for lazydocs output #50

Closed Hermann-SW closed 9 months ago

Hermann-SW commented 1 year ago

Describe the bug:

Global variable comment is ignored for lazydocs output.

Expected behaviour:

In gobal variables section, global variable comment should show as function comment shows for functions.

Steps to reproduce the issue:

Run lazydocs on glob.py:

glob = "foobar"
"""
    global string value
"""
glob2 = "foobar2"
"""
    global string value2
"""

def f() -> str:
    """
    returns:
        some string
    """
    return glob

"global string ..." comments do not show in generated lazydocs output:

Technical details:

Possible Fix:

Additional context:

github-actions[bot] commented 1 year ago

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

Hermann-SW commented 1 year ago

I don't know the process, but shouldn't somebody review this issue before marking stale and auto closing?

rmnldwg commented 1 year ago

I would also love to see the ability to document global variables 👍🏻

Really cool package by the way! I just discovered it and love its simplicity.

github-actions[bot] commented 1 year ago

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

github-actions[bot] commented 10 months ago

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