Skip to content

Commit 393002d

Browse files
committed
Add too-much-inference troubleshooting topic
1 parent bbe5578 commit 393002d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/TROUBLESHOOTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ Unfortunately, we need to recommend: use **yarn or npm v3** to install documenta
44
npm v1 and v2 are unable to properly de-duplicate dependencies, so they will
55
create wastefully large `node_modules` directories under documentation.
66

7+
## documentation is inferring _too much_ about my code
8+
9+
If you've written very dynamic JavaScript, all of documentation's intelligence
10+
might not understand it. If:
11+
12+
* documentation is **wrong** in a clear way, please [open a descriptive issue](https://github.com/documentationjs/documentation/issues) with a code snippet and we can help!
13+
* if it's **right** technically but you want to control your docs entirely,
14+
use the `@name` tag to declare the name of the thing (function, variable, etc)
15+
you're referring to, and the tool will not try to infer anything at all.
16+
717
## Error: watch ENOSPC
818

919
Linux systems can have a low limit of 'watchable files'. To increase this

0 commit comments

Comments
 (0)