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

Remove references to Join from the documentation #419

Merged
merged 2 commits into from
May 14, 2021
Merged

Remove references to Join from the documentation #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6ae67e
Remove references to Join from the documentation
arybczak Apr 15, 2021
f8176d4
Update optics/src/Optics.hs
arybczak May 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions optics-core/src/Optics/Optic.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
-- * the subtyping relation 'Is' with an accompanying 'castOptic' function to
-- convert an optic kind;
--
-- * the 'Join' operation used to find the optic kind resulting from a
-- * the 'JoinKinds' class used to find the optic kind resulting from a
-- composition.
--
-- Each optic kind is identified by a "tag type" (such as 'A_Lens'), which is an
Expand All @@ -36,7 +36,7 @@ module Optics.Optic
-- * Composition
-- | The usual operator for composing optics is ('%'), which allows different
-- optic kinds to be composed, automatically calculating the resulting optic
-- kind using 'Join'.
-- kind using 'JoinKinds'.
--
-- The ('.') function composition operator cannot be used to compose optics,
-- because /optics are not functions/. The ('Control.Category..') operator
Expand Down
5 changes: 3 additions & 2 deletions optics/src/Optics.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,9 +528,10 @@ import Data.Either.Optics as P
-- generates a type error if the composition does not make sense.
--
-- The optic kind resulting from a composition is the least upper bound (join)
-- of the optic kinds being composed, if it exists. The 'Join' type family
-- of the optic kinds being composed, if it exists. The 'JoinKinds' class
-- computes the least upper bound given two optic kind tags. For example the
-- 'Join' of a 'Lens' and a 'Prism' is an 'AffineTraversal'.
-- constraint 'JoinKinds A_Lens A_Prism k' makes GHC infer that @k@ must be
-- 'An_AffineTraversal'.
--
-- >>> let res :: JoinKinds A_Lens A_Prism k => Proxy k; res = Proxy
-- >>> :t res
Expand Down