Git Product home page Git Product logo

typedoc-repros's Introduction

TypeDoc reproductions

If you find a bug in TypeDoc and file an issue, it's helpful -- even necessary -- to create a minimal reproduction of the bug.

This link explains why we ask for a minimal reproduction. Thank you in advance! https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d70ff

One way to do that is opening a pull-request on this repository with your reproduction. Github Actions will execute ./run.sh.

You can put anything you want here: add/remove dependencies in package.json, change the commands in run.sh, change the code in ./src/index.ts, or add a hundred more .ts files.

Once your pull request is submitted here, link to it in your TypeDoc bug report.

Forked from the ts-node-repros for TypeDoc.

Bug report

Type aliases generated from io-ts package are expanded by TypeDoc into something unhelpful.

The documentation for myFunc should be something like:

myFunc1(param: Test1): void

instead, it's:

myFunc1(param: {
    num: number;
    str: string;
}): void

Compare this with myFunc2 which is documented as expected.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.