Skip to content

Commit 49be9db

Browse files
authored
Drop "possibly" from force's haddocks (#513)
force indeed copies unconditionally. Even in case like: > force (generate n fun) In principle GHC could be able to elide copying using rewrite rules related to clone/New in practice it doesn't. So it's better to remove possibly since it will only confuse reader. Fixes #511
1 parent 6cf987a commit 49be9db

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

vector/src/Data/Vector.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -892,7 +892,7 @@ createT p = G.createT p
892892
-- ------------------------
893893

894894
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
895-
-- possibly by copying it.
895+
-- by copying it.
896896
--
897897
-- This is especially useful when dealing with slices. For example:
898898
--

vector/src/Data/Vector/Generic.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -805,7 +805,7 @@ createT p = runST (p >>= T.mapM unsafeFreeze)
805805
-- ------------------------
806806

807807
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
808-
-- possibly by copying it.
808+
-- by copying it.
809809
--
810810
-- This is especially useful when dealing with slices. For example:
811811
--

vector/src/Data/Vector/Primitive.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -731,7 +731,7 @@ createT p = G.createT p
731731
-- ------------------------
732732

733733
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
734-
-- possibly by copying it.
734+
-- by copying it.
735735
--
736736
-- This is especially useful when dealing with slices. For example:
737737
--

vector/src/Data/Vector/Storable.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -742,7 +742,7 @@ createT p = G.createT p
742742
-- ------------------------
743743

744744
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
745-
-- possibly by copying it.
745+
-- by copying it.
746746
--
747747
-- This is especially useful when dealing with slices. For example:
748748
--

vector/src/Data/Vector/Strict.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -930,7 +930,7 @@ createT p = G.createT p
930930
-- ------------------------
931931

932932
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
933-
-- possibly by copying it.
933+
-- by copying it.
934934
--
935935
-- This is especially useful when dealing with slices. For example:
936936
--

vector/src/Data/Vector/Unboxed.hs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ createT p = G.createT p
716716
-- ------------------------
717717

718718
-- | /O(n)/ Yield the argument, but force it not to retain any extra memory,
719-
-- possibly by copying it.
719+
-- by copying it.
720720
--
721721
-- This is especially useful when dealing with slices. For example:
722722
--

0 commit comments

Comments
 (0)