better-docs

better-docs copied to clipboard

Version 2.3.2 If an interface extends some parent interface then any inherited members do not show up. Users don't even have a way of knowing that extension is even taking...

cowwoc

How to document generic type parameters?

1

Given: ``` interface Collection {} ``` How can one document type parameter `T`?

cowwoc

Hey, really enjoying writing docs since better-docs :D well done! I've observed a minor issue: Typescript components won't document their props since they are types / interfaces not PropTypes. Any...

osequi

Complex PropTypes support (shape, arrayOf, etc) in component

2

Currently better-docs doesn't properly support complex propTypes which consists of a propType nested in another (for example, propTypes.shape and propTypes.arrayOf). Instead it just renders this property as being 'shape' or...

deanolium

@component, Parcel: error with Meteor package import

5

I have a Meteor app, and I'm getting this error when trying to document a React component with the @component tag for component files that import a Meteor package. Not...

OliverColeman

Adding timestamp indicating when better-docs was run

2

I have better-docs integrated into my CI pipeline and it would be nice to know when it was run over my code. According to the jsdocs documentation, the timestamp should...

philipmjohnson

Please support Class-Style Vue Components, for example: ``` import { Vue, Component, Watch } from 'vue-property-decorator' import { RouteConfig } from 'vue-router' /** * App Vue * * @component */...

zouzg7829

Non-annotated properties ignored in typescript

1

Given: ``` class Foo { /** @param bar some-info */ constructor({ bar = 'bar' }: { bar: string }) { } baz(something:string) {} } ``` Gives following output: As you...

ThibaultJanBeyer

Abilty to use import path aliases on components

2

It is very common to use aliases in the module import paths in Vue (and possibly React too). The default Vue configuration has `@` set as an alias to the...

skourismanolis

Bulma CSS tag class conflicts with Prettier CSS

1

Prettier adds the class `tag` to HTML tags when doing syntax highlighting but it seems this is the same name Bulma CSS uses for something else causing a poorly rendered...

sukima