Documentation on escaping utils
Open
- Dominant language
- JavaScript
- Stars
- 69
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
It's very nice of BH to expose `xmlEscape`, `attrEscape` and `jsAttrEscape`.
These handy methods definitely should be documented.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the xmlEscape, attrEscape, and jsAttrEscape entry points in the BH repository and checking how existing APIs are documented. Document what each escaping utility does and how it should be used; the issue is done when all three methods have clear documentation.
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
- Mostly clear
- Newbie friendliness
- 45/100