documentationjs / documentationjs/documentation

Better flow type support for complex types

Open
#742 12 comments 0 reactions 0 assignees View on GitHub
bug evaluating
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

As far as I can see the current flow type support doesn't support the use of the actual type definition.

For example:

```
/**
* A ComplexType with some properties
*/
export type ComplexType = {
a: number,
b: number,
};
```

only outputs:

![image](https://cloud.githubusercontent.com/assets/2486553/25285240/dc411d42-26b9-11e7-885b-79c9da1e9972.png)

However, I would expect that the documentation also lists the properties of the type, since I don't want to mirror the definitions in the comments.

Are there any plans for that, or a workaround I could use?

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.