DavidWells / DavidWells/markdown-magic
The `keepComments` option is not documented
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 868
- Forks
- 223
- PR merge metrics
- No merged PRs in 30d
Description
A keepComments option is processed but is not documented.
Should we add it in the doc or remove it in the code?
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
Start in lib/transforms/remote.js at the keepComments option referenced by the issue, then inspect the repository's existing documentation structure. Resolve whether the supported behavior should be documented or removed, and consider the issue done when that decision is reflected consistently in the documentation or code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100