api parse error message is not useful for `cfx docs`

RESOLVED FIXED

Status

Add-on SDK
Documentation
RESOLVED FIXED
7 years ago
7 years ago

People

(Reporter: Erik Vold, Unassigned)

Tracking

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment)

(Reporter)

Description

7 years ago
I'm getting the following error message when I try to run cfx docs, unfortunately idk what file is causing the problems because the error message does not tell me. It would be nice if this error message included the problem file in the traceback someplace.

$ source bin/activate
Welcome to the Add-on SDK. Run 'cfx docs' for assistance.
(addon-sdk)$ cfx docs
Generating documentation...
Traceback (most recent call last):
  File "/github/addon-sdk/bin/cfx", line 29, in <module>
    cuddlefish.run()
  File "/github/addon-sdk/python-lib/cuddlefish/__init__.py", line 468, in run
    docs_home = generate.generate_docs(env_root)
  File "/github/addon-sdk/python-lib/cuddlefish/docs/generate.py", line 52, in generate_docs
    generate_docs_from_scratch(env_root, base_url, docs_dir)
  File "/github/addon-sdk/python-lib/cuddlefish/docs/generate.py", line 152, in generate_docs_from_scratch
    generate_file_tree(env_root, docs_src_dir, web_docs, generate_api_doc)
  File "/github/addon-sdk/python-lib/cuddlefish/docs/generate.py", line 169, in generate_file_tree
    generate_file(env_root, src_path, web_docs)
  File "/github/addon-sdk/python-lib/cuddlefish/docs/generate.py", line 179, in generate_api_doc
    docs_parsed = list(apiparser.parse_hunks(docs_md))
  File "/github/addon-sdk/python-lib/cuddlefish/docs/apiparser.py", line 269, in parse_hunks
    api, line_number = APIParser().parse(lines, line_number)
  File "/github/addon-sdk/python-lib/cuddlefish/docs/apiparser.py", line 113, in parse
    raise ParseError("closing </api> tag not found", lineno + 1)
cuddlefish.docs.apiparser.ParseError: ParseError: the JS API docs were unparseable on line 61: closing </api> tag not found
(Reporter)

Comment 1

7 years ago
Created attachment 564739 [details]
Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/241

Pointer to Github pull-request
Component: General → Documentation
QA Contact: general → documentation
Attachment #564739 - Flags: review?(wbamberg)
Comment on attachment 564739 [details]
Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/241

Thanks Erik!
Attachment #564739 - Flags: review?(wbamberg) → review+
This landed already.
Status: NEW → RESOLVED
Last Resolved: 7 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.