lit / lit/lit.dev

Hide the TemplateResult type branding field

Open
#865 2 comments 0 reactions 1 assignee View on GitHub

@AndrewJakubowicz is already working on this.

Since Jun 17, 2022.

Dominant language
TypeScript
Stars
142
Forks
230
PR merge metrics
No merged PRs in 30d

Description

In the generated documentation, the [TemplateResult type](https://lit.dev/docs/api/templates/#TemplateResult:~:text=%27lit%27%3B-,Type,-%7B_%24litType%24%3A) shows up as `{_$litType$: T, strings: TemplateStringsArray, values: Array}`.

This is an internal detail that we don't need to show in documentation.
See https://github.com/lit/lit.dev/pull/864#issuecomment-1159238347

### Proposals

- For `TemplateResult`, hide the Type section?

Contributor guide

Open the contributing guide

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.