haskell / haskell/filepath

Haddock "source" links are broken since the `OsPath` transition

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

Description

Before: https://hackage.haskell.org/package/filepath-1.4.2.2/docs/src/System.FilePath.Posix.html#takeFileName

After: https://hackage.haskell.org/package/filepath-1.4.100.3/docs/src/System.FilePath.Posix.html#takeFileName

@hasufell I think I understand the underlying motivation, and I am generally sympathetic to DRYing things up, this is why so far I refrained from reporting this as a bug.

However, I think that this puts us into an unfortunate situation:

1. Most importantly, code is far more often read than written. This is why personally I would not be willing to sacrifice readability for DRYness.

1. But also, CPP is a real challenge for tooling. This does not only affect you if you work on a package that makes heavy use of CPP. It also makes it difficult to e.g. implement a "go to definition" that works across packages. By my book less CPP is always a good thing.

1. For me, the final straw is that it's not only `filepath`, but that I see a spreading pattern here (`directory`, `file-io`, ...).

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.