Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

repro for callable variable missing docs #20

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion run.sh 100644 → 100755
Expand Up @@ -20,4 +20,5 @@ set -v
# if TypeDoc's output doesn't match what you expected. Here's one example
# checking that the name from package.json is used in TypeDoc's output.

test $(jq '.name' docs/docs.json) = '"typedoc-repros"'
test $(jq '.children[0].signatures[0].comment.summary[0].text' docs/docs.json) = '"exported-docs"'
test $(jq '.children[0].signatures[0].parameters[0].comment.summary[0].text' docs/docs.json) = '"param-docs"'
10 changes: 8 additions & 2 deletions src/index.ts
@@ -1,4 +1,10 @@
const obj = {
/** function-docs */
fn(x: unknown) {}
}

/**
* Some code reproducing a bug.
* exported-docs
* @param x param-docs
*/
export const bug = 123;
export const bug = obj.fn;