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

README has stale versioned links #95

Open
quasicomputational opened this issue Jun 13, 2018 · 0 comments
Open

README has stale versioned links #95

quasicomputational opened this issue Jun 13, 2018 · 0 comments

Comments

@quasicomputational
Copy link
Collaborator

Not submitting a PR (yet) because it's not quite obvious what the Right Thing here is.

If the links were made relative (and the examples were put into extra-doc-files), we would be doing the right thing: sdists, installed versions, browsing the repository on GitHub, etc would all be linking to appropriate versions. But relative links will break in Hackage's README display (I think? I haven't actually checked).

If we go with explicitly versioned links (i.e., just bump the version), then we've got to remember to bump all of them with each release, and HEAD will be pointing to the last released version, which might not be current.

If we go with unversioned links, then sdists, installed versions and Hackage will have links pointing to potentially bleeding-edge examples that won't work with the released versions.

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

No branches or pull requests

1 participant