palantir / palantir/documentalist

Interface property default values include extra markup

Open
#245 0 comments 0 reactions 1 assignee View on GitHub

@adidahiya is already working on this.

Since Oct 25, 2023.

bug
Dominant language
TypeScript
Stars
160
Forks
32
Avg merge
1h 40m
Merged PRs (30d)
141

Description

This is a regression in v5.0.0 caused by #156

Previously, @default tag values on interface properties would just contain the text of the default value:

image

Now in v5.0.0, we get extra markup around the value which is unnecessary and should be stripped out in the output:

image

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.