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

Unify mkNV* and NV* patterns by bidirectional synonyms in value modules #1046

Merged
merged 13 commits into from
Jan 23, 2022

Conversation

soulomoon
Copy link
Collaborator

@soulomoon soulomoon commented Jan 22, 2022

changes draft related to #1045

src/Nix/Value.hs Outdated Show resolved Hide resolved
src/Nix/Value.hs Outdated Show resolved Hide resolved
@soulomoon soulomoon marked this pull request as ready for review January 23, 2022 15:39
@soulomoon soulomoon changed the title Unify mk* and pattern in value modules Unify mkNV* and NV* patterns by bidirectional synonyms in value modules Jan 23, 2022
src/Nix/Builtins.hs Outdated Show resolved Hide resolved
Copy link
Collaborator

@Anton-Latukha Anton-Latukha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great changes.

@Anton-Latukha Anton-Latukha merged commit 99508f2 into haskell-nix:master Jan 23, 2022
@Anton-Latukha
Copy link
Collaborator

Thank you, I love these changes.

@soulomoon
Copy link
Collaborator Author

Thank you too @Anton-Latukha for the help of reviewing the code.

Comment on lines +6 to +9
* Introduction:
* `Nix.Value`
* [(link)](https://github.com/haskell-nix/hnix/pull/1046/files) Constraint `NVConstraint f = (Comonad f, Applicative f)` was introduced, in order to unify builder `mkNV*` and `NV*` patterns.

Copy link
Collaborator

@Anton-Latukha Anton-Latukha Jan 23, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would note that Breaking & Additional - generally enough. If it is not major (breaking) change - everything else is additional niceties information. First - is first aid network, second is a daily news network.

For example, this change does not belong into "Introduction", it can be thought to belong to Additional, but as it changes type signatures in a number of places - it is a Breaking change. As it adds Comonad or Applicative (literal declaration of having requirement for such type class instance existence when there was none before - is a breakage) somewhere when it was not before.

The first most important client type of ChangeLogs in Haskell projects - is downstream developers. & generally under the semantic agenda of supporting the update, people look into changelogs. So the most important and clear thing ChangeLog should do - is to have as many breaking changes described precisely as possible. That it is an introduction of something into the code - can be said in explanation of breaking changes.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was originally put it into breaking, but it comes to me that it is jut short hands for Comonad f, Applicative f.
An introduction of short hand for the new constraint requirements, I think it is both introduction and breaking, sort of dangling in the middle.

Since you remind me of the change logs focus is on breaking changes and reading experience of developers , move back to breaking does seem to make more sense. Thanks, surely will modify it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done in #1048

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

Successfully merging this pull request may close these issues.

2 participants