documentationjs / documentationjs/gulp-documentation

`polyglot` gives me a blank documentation

Open
#26 6 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
64
Forks
13
PR merge metrics
No merged PRs in 30d

Description

I have the following configuration in my `gulpfile.js`:

```
gulp.task("docs", function() {
gulp.src("src/**/*.js")
.pipe(documentation('html', { shallow: true }, {
name: pkg.name,
version: pkg.version
}))
.pipe(gulp.dest("dist/docs"));
});
```

When I add `polyglot: true` after the `shallow: true`, the generated documentation becomes blank. I do not want the JavaScript to be analyzed.

One particular reason is that overloaded functions have a lot of `argN: any` at the end if you leave it out in the documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.