jsr icon indicating copy to clipboard operation
jsr copied to clipboard

Documenting transitive types in API/symbols?

Open arv opened this issue 1 year ago • 0 comments

I was browsing the @badrap/valita symbols and the generated API docs and I see a lot of symbols are not linked/documented.

For example:

https://jsr.io/@badrap/valita/doc/~/ArrayType#method_func_0

func(arr: unknown, flags: number): RawResult<ArrayOutput<Head, Rest>>

Here neither RawResult nor ArrayOutput are linked or documented. These two type definitions are not exported by src/index.ts so it is understandable that they are not linked. But, to make things useful the reader of the API docs would want to see what these types are even if they cannot be imported directly.

arv avatar Mar 04 '24 09:03 arv