haskell / haskell/filepath

Doc bugs

Open
#166 0 comments 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Haskell
Stars
74
Forks
38
PR merge metrics
No merged PRs in 30d

Description

In GitLab by @maerwald on Sep 8, 2022, 09:25

Reported by Aura via email

----

The module documentation of System.OsPath.Posix.Internal states the following:

"A library for FilePath manipulations, using Posix style paths on all
platforms. Importing System.FilePath is usually better."

I have a feeling that this documentation should not suggest using
System.FilePath anymore.

Also I wonder why there is so much introductory documentation in the .Internal
module, and none in the System.OsPath.Posix module, where most people would
probably look for it. (I know the types are different – ShortByteString vs.
PosixPath.)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.