-
Notifications
You must be signed in to change notification settings - Fork 178
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
Fix mention of foldl'
in Haddocks of unions
/unionsWith
#832
base: master
Are you sure you want to change the base?
Conversation
Another option would be to remove the inlined implementation from the Haddocks all-together, as the up-to-date actual implemenation is just one click away. |
The documentation should have everything a user needs to know to understand both the meaning of the function and its performance. In this case, I think the easiest way to do that is to give the actual implementation. |
In the future, please refrain from including images in issues or issue discussions unless they contribute substantially; they are generally bad for accessibility. A diagram of an idea or a rendering of a formatting change would be fine, but these images weren't helpful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's actually another mistake: The functions work on any Foldable
, not just lists.
@@ -1773,7 +1773,7 @@ maxView t = case maxViewWithKey t of | |||
Union. | |||
--------------------------------------------------------------------} | |||
-- | The union of a list of maps: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-- | The union of a list of maps: | |
-- | The union of a 'Foldable' of maps: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would go with "'Foldable' container
".
@@ -1788,7 +1788,7 @@ unions ts | |||
#endif | |||
|
|||
-- | The union of a list of maps, with a combining operation: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
-- | The union of a list of maps, with a combining operation: | |
-- | The union of a 'Foldable' of maps, with a combining operation: |
@konsumlamm Personally, I have no opinion on whether that is misleading (after all, |
Tiny documentation fix, was confused by this for a split second today 😆
Before:
After: