obsidianmd / obsidianmd/obsidian-developer-docs
Missing signatures of functional interfaces
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 521
- Forks
- 174
- PR merge metrics
- No merged PRs in 30d
Description
The docs page for https://docs.obsidian.md/Reference/TypeScript+API/MarkdownPostProcessor
is missing the following (the most essential) part
(el: HTMLElement, ctx: MarkdownPostProcessorContext): Promise<any> | void;
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
Open the MarkdownPostProcessor documentation page named in the issue and compare its functional-interface documentation with the requested TypeScript signature. Add the missing signature, then verify that the page displays the HTMLElement, MarkdownPostProcessorContext, Promise, and void types as specified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100