From 36493eee748bc35e2d4ecb09992f3c3eae42f4e8 Mon Sep 17 00:00:00 2001
From: Mohammed Anas <6daf084a-8eaf-40fb-86c7-8500077c3b69@anonaddy.me>
Date: Thu, 22 Apr 2021 19:26:30 +0000
Subject: [PATCH] Use backticks around PS code in docs (#148)

* Use backticks around PS code in docs

* Add change to CHANGELOG.md
---
 CHANGELOG.md                    |  1 +
 src/Data/String/CodePoints.purs | 14 +++++++-------
 src/Data/String/CodeUnits.purs  |  2 +-
 3 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 311b72b..c3bf386 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -11,6 +11,7 @@ New features:
 Bugfixes:
 
 Other improvements:
+- Surround code with backticks in documentation (#148)
 
 ## [v5.0.0](https://github.com/purescript/purescript-strings/releases/tag/v5.0.0) - 2021-02-26
 
diff --git a/src/Data/String/CodePoints.purs b/src/Data/String/CodePoints.purs
index 7d0f528..65e0b55 100644
--- a/src/Data/String/CodePoints.purs
+++ b/src/Data/String/CodePoints.purs
@@ -42,7 +42,7 @@ import Data.String.Unsafe as Unsafe
 import Data.Tuple (Tuple(..))
 import Data.Unfoldable (unfoldr)
 
--- | CodePoint is an Int bounded between 0 and 0x10FFFF, corresponding to
+-- | CodePoint is an `Int` bounded between `0` and `0x10FFFF`, corresponding to
 -- | Unicode code points.
 newtype CodePoint = CodePoint Int
 
@@ -67,7 +67,7 @@ instance boundedEnumCodePoint :: BoundedEnum CodePoint where
     | n >= 0 && n <= 0x10FFFF = Just (CodePoint n)
     | otherwise = Nothing
 
--- | Creates a CodePoint from a given Char.
+-- | Creates a `CodePoint` from a given `Char`.
 -- |
 -- | ```purescript
 -- | >>> codePointFromChar 'B'
@@ -178,7 +178,7 @@ codePointAtFallback n s = case uncons s of
   _ -> Nothing
 
 -- | Returns a record with the first code point and the remaining code points
--- | of the string. Returns Nothing if the string is empty. Operates in
+-- | of the string. Returns `Nothing` if the string is empty. Operates in
 -- | constant space and time.
 -- |
 -- | ```purescript
@@ -243,7 +243,7 @@ countTail p s accum = case uncons s of
   _ -> accum
 
 -- | Returns the number of code points preceding the first match of the given
--- | pattern in the string. Returns Nothing when no matches are found.
+-- | pattern in the string. Returns `Nothing` when no matches are found.
 -- |
 -- | ```purescript
 -- | >>> indexOf (Pattern "𝐀") "b 𝐀𝐀 c 𝐀"
@@ -257,7 +257,7 @@ indexOf p s = (\i -> length (CU.take i s)) <$> CU.indexOf p s
 
 -- | Returns the number of code points preceding the first match of the given
 -- | pattern in the string. Pattern matches preceding the given index will be
--- | ignored. Returns Nothing when no matches are found.
+-- | ignored. Returns `Nothing` when no matches are found.
 -- |
 -- | ```purescript
 -- | >>> indexOf' (Pattern "𝐀") 4 "b 𝐀𝐀 c 𝐀"
@@ -272,7 +272,7 @@ indexOf' p i s =
   (\k -> i + length (CU.take k s')) <$> CU.indexOf p s'
 
 -- | Returns the number of code points preceding the last match of the given
--- | pattern in the string. Returns Nothing when no matches are found.
+-- | pattern in the string. Returns `Nothing` when no matches are found.
 -- |
 -- | ```purescript
 -- | >>> lastIndexOf (Pattern "𝐀") "b 𝐀𝐀 c 𝐀"
@@ -292,7 +292,7 @@ lastIndexOf p s = (\i -> length (CU.take i s)) <$> CU.lastIndexOf p s
 -- | greater than the number of code points in the string is equivalent to
 -- | searching in the whole string.
 -- |
--- | Returns Nothing when no matches are found.
+-- | Returns `Nothing` when no matches are found.
 -- |
 -- | ```purescript
 -- | >>> lastIndexOf' (Pattern "𝐀") (-1) "b 𝐀𝐀 c 𝐀"
diff --git a/src/Data/String/CodeUnits.purs b/src/Data/String/CodeUnits.purs
index dfa0482..fbc1803 100644
--- a/src/Data/String/CodeUnits.purs
+++ b/src/Data/String/CodeUnits.purs
@@ -37,7 +37,7 @@ import Data.String.Unsafe as U
 -------------------------------------------------------------------------------
 
 -- | If the string starts with the given prefix, return the portion of the
--- | string left after removing it, as a Just value. Otherwise, return Nothing.
+-- | string left after removing it, as a `Just` value. Otherwise, return `Nothing`.
 -- |
 -- | ```purescript
 -- | stripPrefix (Pattern "http:") "http://purescript.org" == Just "//purescript.org"