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.

Sign up for GitHub

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

Jump to bottom

yampa: module FRP.Yampa.Event exports internal function maybeToEvent #267

Closed
ivanperez-keera opened this issue Apr 29, 2023 · 0 comments
Closed

yampa: module FRP.Yampa.Event exports internal function maybeToEvent #267

ivanperez-keera opened this issue Apr 29, 2023 · 0 comments
Assignees
@ivanperez-keera
Labels
bug
Milestone
0.14.5

Comments

@ivanperez-keera
Copy link
Owner

The function FRP.Yampa.Event.maybeToEvent is labelled as internal, yet it is being exported by the module. The function is useful and is being used in the wild:

This is either an error in the implementation (the function should not be exported), or an error in the design (the function should be offered), or an error in the documentation (the comment and haddock section header indicator are incorrect).
ivanperez-keera added a commit that referenced this issue Oct 7, 2023
@ivanperez-keera
yampa: Make FRP.Yampa.Event.maybeToEvent public. Refs #267.
b18a942 
The function FRP.Yampa.Event.maybeToEvent is labelled as internal, yet
it is being exported by the module. The function is useful and is being
used in the wild, so removing it now would break existing applications.

This commit makes the function "officially" public. It changes the
comment stating that it is internal, and it moves it within the module
to a location that makes more sense in terms of explaining the API.
ivanperez-keera added a commit that referenced this issue Oct 7, 2023
@ivanperez-keera
yampa-test: Move test for consistency with module tested. Refs #267.
5a12bd1 
A prior commit moved the function FRP.Yampa.Event.maybeToEvent within
its module to a location that made more sense in terms of explaining the
API.

This commit moves the accompanying test in yampa-test, so that the test
module remains consistent with the module it tests.
ivanperez-keera added a commit that referenced this issue Oct 7, 2023
@ivanperez-keera
yampa: Document changes in CHANGELOG. Refs #267.
e7abdd2
ivanperez-keera added a commit that referenced this issue Oct 7, 2023
@ivanperez-keera
yampa-test: Document changes in CHANGELOG. Refs #267.
9c029b9
@ivanperez-keera ivanperez-keera self-assigned this Oct 7, 2023
@ivanperez-keera ivanperez-keera added this to the 0.14.5 milestone Oct 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
bug
Projects
None yet
Milestone
0.14.5
Development

No branches or pull requests
1 participant
@ivanperez-keera