Skip to content

documentation builds all javascript files, not just those specified #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
balupton opened this issue May 2, 2016 · 4 comments
Closed

Comments

@balupton
Copy link

balupton commented May 2, 2016

If I do documentation build ./source/**.js -f html -g -o docs even javascript files not within ./source are added to the docs... this should not be the case

documentation build ./source/*.js -f html -g -o docs does the same

$ documentation --version
4.0.0-beta2
@balupton
Copy link
Author

balupton commented May 2, 2016

If not supported, http://npmjs.com/glob for the input string when using the CLI would be great

@balupton
Copy link
Author

balupton commented May 2, 2016

--shallow seems to fix this, however this seems like it should be the default behaviour... as otherwise specifying a glob pattern is useless if everything is used anyway

@tmcw
Copy link
Member

tmcw commented May 2, 2016

The default behavior of documentation.js is following dependency trees (see the 4th heading). In this way the expectation should be the same as browserify or webpack or node - you don't specify all of the files on the CLI, only the entry files. Long-winded way of saying, feature, not bug.

--shallow turns off dependency resolution and has a behavior more typical of non-JS-aware utilities, but I'm not really that sure that it's a good default. See discussion in #342 for one soul-searching moment I had about this.

@tmcw
Copy link
Member

tmcw commented Jun 17, 2016

Closing; --shallow is the default, and via #342 the majority user expectation - I've added a note to FAQ.md and referenced this issue to make this information more discoverable.

@tmcw tmcw closed this as completed Jun 17, 2016
rhendric pushed a commit to rhendric/documentation that referenced this issue Sep 15, 2022
* Remove MultipleFFIModules documentation

It is a template file and the error was removed in 0.12.0

* Add UnusedDeclaration warning docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants