palantir / palantir/documentalist

TypeScript support for Utility Types

Open
#97 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hey all,

Any plans on supporting Utility Types such as Partial<Foo> or Omit<Foo, 'bar'>? Is there a trick I'm missing? Thanks!

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.

Research direction

No files, tests, or entry points are named. Start by reproducing the reported TypeScript cases, Partial and Omit<Foo, 'bar'>, and trace how existing TypeScript types are processed. Done means both utility types are supported in the generated documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.