documentationjs / documentationjs/documentation

module name inference should depend on current directory?

Open
#183 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

[A bit of odd behavior from standard JSDoc](http://usejsdoc.org/tags-module.html):

> If the module name is not provided, it is derived from the module's path and filename. For example, suppose I have a file `test.js`, located in the `src` directory, that contains the block comment `/** @module */`. Here are some scenarios for running JSDoc and the resulting module names for test.js:
>
> **Derived module names if none is provided.**
>
> ```
> # from src/
> jsdoc ./test.js # module name 'test'
>
> # from src's parent directory:
> jsdoc src/test.js # module name 'src/test'
> jsdoc -r src/ # module name 'test'
> ```

Should documentation.js emulate this?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.