Skip to content

Commit

Permalink
Update src/Data/StringVariants/NullableNonEmptyText.hs
Browse files Browse the repository at this point in the history
  • Loading branch information
friedbrice authored Jan 4, 2024
1 parent a9e8dbb commit a6656a8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/Data/StringVariants/NullableNonEmptyText.hs
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ import Prelude
--
-- @'NullableNonEmptyText' n@ is used in API types to represent optional text fields when you do not want an empty string to fail to parse.
-- Like 'NonEmptyText', the payload 'Text' is guaranteed to be non-empty, within the character limit, and stripped of whitespace.
-- Unlike 'NonEmptyText', it will successfully parse empty strings as 'Nothing'.
-- Unlike 'NonEmptyText', it will successfully parse empty strings as 'nullNonEmptyText'.
--
-- Since Aeson version 2.2, fields of this type maybe be missing, @null@, or empty without failing to parse.
-- Avoid using @Maybe (NullableNonEmptyText n)@ in API types, since it creates unnecessary edge cases that complicate the code.
Expand Down

0 comments on commit a6656a8

Please sign in to comment.