palantir / palantir/documentalist
@event tags are erased
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 160
- Forks
- 32
- Avg merge
- 1h 40m
- Merged PRs (30d)
- 141
Description
Currently I'm using the compiler. I use the compiler to build JSON, which I then use to create markdown. According to https://jsdoc.app/tags-event.html, I should be able to use @event tags to document different events that are emitted.
Desired usage:
/**
* @event Drawer:event Emits when the drawer has closed.
* @type {object}
* @event Drawer:opened Emits when the drawer has opened.
* @type {object}
*/
export class Drawer {
Actual Result:
Using this notation actually removes the Drawer entry from docs.json.
Contributor guide
No contributing guide indexed for this repository
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
Start with the compiler and reproduce the issue using the provided Drawer example, then inspect how @event tags are converted into docs.json. Done means the Drawer entry remains present and both event declarations are represented without being erased.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100