Improve consistency of module naming #383
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
+ System.IO.Resource -> System.IO.Resource.Linear + Streaming.Internal -> System.Linear.Internal + Data.Unrestricted.Internal -> Data.Unrestricted.Linear.Internal + Data.Arity.Linear.Internal.Arity -> Data.Arity.Linear.Internal
aspiwack
approved these changes
Feb 15, 2022
| @@ -14,7 +14,7 @@ Linear base consists of the following: | |||
| * tools ported from [`base`] and from other critical haskell | |||
| libraries, like `lens`, | |||
| * new APIs for using system resources, e.g., file I/O in | |||
| [`System.IO.Resource`], | |||
| [`System.IO.Resource.Linear`], | |||
There was a problem hiding this comment.
This one is a breaking change. We will have to communicate on it.
There was a problem hiding this comment.
We need to write it down in the changelog, I suppose? Do we need to do something else?
(I am referencing the changelog issue there to not forget: #377 )
There was a problem hiding this comment.
Yes, in the change log. All the breaking change will have to be clearly identified.
|
I think that the Optics hierarchy is fine. |
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.
Before 1.0 release, I think that we should ensure that our naming conventions are respected for both internal and public modules.
In this PR, I renamed:
The
Control.Opticsdirectory structure seemed a bit odd to me (but I haven't changed it yet), because it contains modules not ending with either.Linearor.Linear.Internal.xxxas this is the case in every other namespace. Should we rename something for this one?Closes #373 . Closes #380 .