documentationjs / documentationjs/documentation

Empty documentation if file is all exports

Open
#1,237 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

Input code

```
export {combine} from './combine'
export {sample} from './sample'

export type {Domain} from 'effector/domain'
export {createDomain} from 'effector/domain'

export type {Event} from 'effector/event'
export {
createEvent,
forward,
fromObservable,
chord,
filter,
} from 'effector/event'

export type {Effect} from 'effector/effect'
export {createEffect} from 'effector/effect'

export type {Store} from 'effector/store'
export {
createStore,
createStoreObject,
setStoreName,
extract,
createApi,
restore,
restoreEvent,
restoreEffect,
restoreObject,
withProps,
} from 'effector/store'

export {Kind, clearNode, createGraph as createNode, step} from 'effector/stdlib'
export {launch} from 'effector/kernel'
export type {kind} from 'effector/stdlib'

export {
invariant,
warning,
isUnit,
isStore,
isEvent,
isEffect,
isDomain,
is,
} from 'effector/validate'
export {version} from 'effector/flags'

//eslint-disable-next-line
export * as blocks from 'effector/blocks'
```

Output docs

```

### Table of Contents
```

* What version of documentation.js are you using?: 10.1.0
* How are you running documentation.js (on the CLI, Node.js API, Grunt, other?):CLI

Contributor guide

Open the contributing guide

Research direction

Reproduce the issue with the all-exports input using documentation.js 10.1.0 through the CLI, then trace how that input is processed into the generated documentation. Done means the generated output documents the exported API instead of containing only the generated header and table of contents.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.