Skip to content

In tag.py, NameError: name 'context' is not defined #12

@tjbtjbtjb

Description

@tjbtjbtjb

I just trying to use you jbheard/markdown-docs@v1 system to produce automatic documentation within the github action framework.

I got the following error.

  File "/generatedocs/src/main.py", line 29, in <module>
    data = get_data(classes, functions, output)
  File "/generatedocs/src/doc_loader.py", line 8, in get_data
    c_data = get_class_data(c)
  File "/generatedocs/src/doc_loader.py", line 23, in get_class_data
    f_data = get_function_data(func, _class.name)
  File "/generatedocs/src/doc_loader.py", line 29, in get_function_data
    doc = utils.parse_docstring(docstring, context + ' ' + func.name)
  File "/generatedocs/src/utils.py", line 93, in parse_docstring
    collection, result = Tag.parse(curr)
  File "/generatedocs/src/tag.py", line 41, in parse
    result = tag.parse_string(string)
  File "/generatedocs/src/tag.py", line 29, in parse_string
    .format(context, line))
NameError: name 'context' is not defined

It seems to me that in the code the context and line variable are not defined here. Or perhaps may have badly configured my github action yaml file or my python docstrings. But I cannot understand fully what's currently happens.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions