temporalio / temporalio/sdk-typescript
[Docs] Make method overloads more obvious in docs
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 917
- Forks
- 224
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 43
Description
Is your feature request related to a problem? Please describe.
Hard to notice that a fn has overloads, for example:
Describe the solution you'd like
Some visual change, and maybe a list of options (preferably linked) under the header:
Like
# condition
- condition(fn, timeout)
- condition(fn)
## condition(fn, timeout)
...
## condition(fn)
...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or documentation entry point is named. Start by locating the documentation renderer and an example with overloaded functions, then compare its current output with the proposed linked-options layout. Done means overloads are visibly distinguishable and each option links to its corresponding section.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100