Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc bugs #166

Open
hasufell opened this issue Sep 8, 2022 · 0 comments
Open

Doc bugs #166

hasufell opened this issue Sep 8, 2022 · 0 comments

Comments

@hasufell
Copy link
Member

hasufell commented Sep 8, 2022

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.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant