Deprecate 'Clash.Prelude.DataFlow' #1490
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Current API makes it impossible to use for designs on multiple domains. We should probably design something closer to cchalmers's circuit as defined over at github.com/cchalmers/circuit-notation. Deprecating due to namespace clashes for users designing dataflow libraries that are better suited for real world designs.
| @@ -18,7 +18,7 @@ Self-synchronizing circuits based on data-flow principles. | |||
| {-# OPTIONS_GHC -fplugin GHC.TypeLits.Normalise #-} | |||
| {-# OPTIONS_HADDOCK show-extensions #-} | |||
|
|
|||
| module Clash.Prelude.DataFlow | |||
| module Clash.Prelude.DataFlow {-# DEPRECATED "Module will be removed in future versions of clash-prelude." #-} | |||
There was a problem hiding this comment.
May or may not be the time for this, but I feel like we should commit to some fixed offset between deprecating something and removing it. The reason being
- users would know how quickly they need to change their code before it breaks
- we could better ensure deprecated code isn't removed too quickly / slowly
Thoughts?
There was a problem hiding this comment.
Agreed. Ideally we should point users to some alternative.
There was a problem hiding this comment.
Guess I'll work a bit harder on martijn-circuits this weekend :-)
There was a problem hiding this comment.
Well now that you know a circuit is a symmetric monoidal category, what's stopping you? 😉
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current API makes it impossible to use for designs on multiple domains.
We should probably design something closer to cchalmers's circuit as
defined over at github.com/cchalmers/circuit-notation.
Deprecating due to namespace clashes for users designing dataflow
libraries that are better suited for real world designs.
edit: clash-protocols is now live!