encodeFS is not documented
- Dominant language
- Haskell
- Stars
- 74
- Forks
- 38
- PR merge metrics
- No merged PRs in 30d
Description
I noticed that encodeFS lacks haddock documentation about what it does, eg see here:
https://hackage.haskell.org/package/filepath-1.5.4.0/docs/System-OsPath.html#v:encodeFS
By process of elimination on the 3 strategies that the documentation discusses, I was able to guess that it mimics the behavior of the base library.
I think this should be documented, like decodeFS is.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating encodeFS in the System.OsPath module and compare its existing documentation with decodeFS. Review the three documented encoding strategies and the linked Hackage entry to confirm that encodeFS follows the base library behavior. Done means the Haddock documentation explains what encodeFS does and matches the style of decodeFS.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100