metafizzy / metafizzy/outlayer

Invalid JSDoc (quick fix).

Open
#56 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
166
Forks
63
PR merge metrics
No merged PRs in 30d

Description

Is it possible to adjust JSDoc through the code?
In case if project contains JSDoc validation there are such errors (e.g. when using masonry-layout which uses outlayer):

```
ERROR: Unable to parse a tag's type expression for source file some.js in line XXX with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ...with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array of Outlayer.Items} items": Invalid type expression "Array of Outlayer.Items": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or Element} elems": Invalid type expression "Array or NodeList or Element": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or Element} elems": Invalid type expression "Array or NodeList or Element": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Element, String} element": Invalid type expression "Element, String": Expected "!", "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "?", "@", "[]", "\\", "_", "|", "~", "‌", "‍", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9], or end of input but "," found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Element, String} element": Invalid type expression "Element, String": Expected "!", "#", "$", "(", "-", ".", "/", "0", ":", "<", "=", "?", "@", "[]", "\\", "_", "|", "~", "‌", "‍", Unicode combining mark, Unicode decimal number, Unicode letter number, Unicode lowercase letter, Unicode modifier letter, Unicode other letter, Unicode punctuation connector, Unicode titlecase letter, Unicode uppercase letter, [1-9], or end of input but "," found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.
ERROR: Unable to parse a tag's type expression for source file ... in line ... with tag title "param" and text "{Array or NodeList or HTMLElement} elems": Invalid type expression "Array or NodeList or HTMLElement": Expected "|" but "o" found.
```
May be better to use:
- @param {Element|string}
- @param {Array|NodeList|HTMLElement}
- @param {Array|NodeList|Element}
- @param {Array} (instead of "Array of Outlayer.Items").

Contributor guide

No contributing guide indexed for this repository

Research direction

Search the JavaScript source for the JSDoc forms shown in the issue, including “Array of Outlayer.Items”, comma-separated types, and prose “or” unions. Run the project's JSDoc validation against the affected files. Done means the types use valid JSDoc expressions and the reported parse errors no longer occur.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.