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

By default, do not constrain doctest #691

Closed
wants to merge 1 commit into from

Conversation

andreasabel
Copy link
Contributor

doctest bound has been rotting too quickly.
Just use the latest version by default.
Can always be overwritting by doctest-version option in cabal.haskell-ci.

Closes #690

`doctest` bound has been rotting too quickly.
Just use the latest version by default.
Can always be overwritting by `doctest-version` option in `cabal.haskell-ci`.

Closes haskell-CI#690
@phadej
Copy link
Collaborator

phadej commented Nov 23, 2023

You can specify doctest-version: >=0 in your configuration file.

@phadej phadej closed this Nov 23, 2023
@andreasabel
Copy link
Contributor Author

andreasabel commented Dec 1, 2023

You can specify doctest-version: >=0 in your configuration file.

Yes of course.
But good tooling has sensible defaults. Defaulting to an outdated version isn't a good default.

Removing the constraint would lead to the following workflow:

  1. Usually doctest: True does the job.
  2. A user that needs an older version of doctest would go looking for a way to configure the doctest version used by haskell-ci.

Currently we have:

  1. The doctests fail.
  2. The user may discover that nothing is wrong other than haskell-ci pinning to an outdated version.
  3. The user wonders where this pin comes from as they haven't specified the doctest version.

@phadej
Copy link
Collaborator

phadej commented Dec 1, 2023

Currently we have:

The doctests fail.

Do we? If they worked, they should continue to work.

And that "if it worked, and nothing is explicitly changed, it should work" is my philosophy. You may upgrade haskell-ci (which may have different major version used by default), or change the haskell-ci config or do something else - then things may break (or unbreak) - but you'll know what you have changed.

You won't make me change my mind on this.

@andreasabel
Copy link
Contributor Author

andreasabel commented Dec 2, 2023

Do we? If they worked, they should continue to work.

If they weren't broken, I wouldn't have gone to the effort of changing Haskell CI.
Let me see if I can recover the evidence...

Got it!

@phadej
Copy link
Collaborator

phadej commented Dec 2, 2023

If they weren't broken,

You added GHC-9.8 CI, so you did change something.

@haskell-CI haskell-CI locked and limited conversation to collaborators Dec 2, 2023
@andreasabel andreasabel deleted the doctest branch December 6, 2023 16:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use latest doctest by default
2 participants