Merge pull request #6690 from commercialhaskell/consistency

Consistency of terminology in in-app documentation

Author: mpilgrem

.stan.toml

@@ -94,25 +94,25 @@
 
 # Anti-pattern: Data.ByteString.Char8.pack
 [[ignore]]
-  id = "OBS-STAN-0203-hTeu0Y-389:17"
+  id = "OBS-STAN-0203-hTeu0Y-388:17"
 # ✦ Description:   Usage of 'pack' function that doesn't handle Unicode characters
 # ✦ Category:      #AntiPattern
 # ✦ File:          src\Stack\Init.hs
 #
-#  388 ┃
-#  389 ┃   commentHelp = BC.pack .  intercalate "\n" . map commentLine
-#  390 ┃                 ^^^^^^^
+#  387 ┃
+#  388 ┃   commentHelp = BC.pack .  intercalate "\n" . map commentLine
+#  389 ┃                 ^^^^^^^
 
 # Anti-pattern: Data.ByteString.Char8.pack
 [[ignore]]
-  id = "OBS-STAN-0203-hTeu0Y-406:26"
+  id = "OBS-STAN-0203-hTeu0Y-405:26"
 # ✦ Description:   Usage of 'pack' function that doesn't handle Unicode characters
 # ✦ Category:      #AntiPattern
 # ✦ File:          src\Stack\Init.hs
 #
-#  405 ┃
-#  406 ┃         <> B.byteString (BC.pack $ concat
-#  407 ┃                          ^^^^^^^
+#  404 ┃
+#  405 ┃         <> B.byteString (BC.pack $ concat
+#  406 ┃                          ^^^^^^^
 
 # Anti-pattern: Data.ByteString.Char8.pack
 [[ignore]]

src/Stack/BuildPlan.hs

@@ -91,7 +91,7 @@ instance Exception BuildPlanException where
           , case mapMaybe goRecommend $ Map.toList unknown of
               [] -> []
               rec ->
-                  ("Recommended action: modify the extra-deps field of " ++
+                  ("Recommended action: modify the value of the extra-deps key of " ++
                   toFilePath stackYaml ++
                   " to include the following:")
                   : (rec
@@ -125,7 +125,7 @@ instance Exception BuildPlanException where
       | otherwise = concat
           [ ["The following packages are shadowed by project packages:"]
           , map go (Map.toList shadowed)
-          , ["Recommended action: modify the extra-deps field of " ++
+          , ["Recommended action: modify the value of the extra-deps key of " ++
              toFilePath stackYaml ++
              " to include the following:"]
           , extraDeps

src/Stack/ComponentFile.hs

@@ -432,7 +432,10 @@ logPossibilities dirs mn = do
     , line <> bulletedList (map pretty possibilities)
     , flow "If you are using a custom preprocessor for this module"
     , flow "with its own file extension, consider adding the extension"
-    , flow "to the 'custom-preprocessor-extensions' field in stack.yaml."
+    , flow "to the value of the"
+    , style Shell "custom-preprocessor-extensions"
+    , flow "key in Stack's project-level configuration file"
+    , "(" <> style File "stack.yaml" <> ")."
     ]
  where
   makePossibilities name =

src/Stack/Config.hs

@@ -824,7 +824,7 @@ withBuildConfig inner = do
             , pretty dest <> "."
             , flow "Note: You can change the snapshot via the"
             , style Shell "snapshot"
-            , flow "field there."
+            , flow "key there."
             ]
           p <- getEmptyProject mSnapshot []
           liftIO $ do

src/Stack/Ghci.hs

@@ -1171,13 +1171,16 @@ targetWarnings localTargets nonLocalTargets mfileTargets = do
                 , pretty projectConfigFile <> ","
                 , flow "then you can use"
                 , style Shell "stack init"
-                , flow "to create a new stack.yaml for the packages in the \
-                       \current directory."
+                , flow "to create a new"
+                , style File "stack.yaml"
+                , flow "for the packages in the current directory."
                 , line
                 ]
             , flow "If you want to use the project configuration at"
             , pretty projectConfigFile <> ","
-            , flow "then you can add to its 'packages' field."
+            , flow "then you can add to the value of its"
+            , style Shell "packages"
+            , "key."
             ]
         , ""
         ]

src/Stack/Init.hs

@@ -376,9 +376,8 @@ renderStackYaml p ignoredPackages dupPackages =
    where
     convert v = B.byteString (Yaml.encode $ Yaml.object [(name, v)])
 
-    -- Some fields in stack.yaml are optional and may not be
-    -- generated. For these, we provided commented out dummy
-    -- values to go along with the comments.
+    -- Some keys in stack.yaml are optional and may not be generated. For these,
+    -- we provided commented out dummy values to go along with the comments.
     nonPresentValue "extra-deps" = Just "# extra-deps: []\n"
     nonPresentValue "flags" = Just "# flags: {}\n"
     nonPresentValue "extra-package-dbs" = Just "# extra-package-dbs: []\n"

src/Stack/Types/Snapshot.hs

@@ -43,8 +43,8 @@ instance Exception TypesSnapshotException where
     ]
   displayException (FilepathInDownloadedSnapshot url) = unlines
     [ "Error: [S-4865]"
-    , "Downloaded snapshot specified a 'snapshot: { location: filepath }' "
-    , "field, but filepaths are not allowed in downloaded snapshots.\n"
+    , "Downloaded snapshot specified 'snapshot: { location: filepath }', "
+    , "but filepaths are not allowed in downloaded snapshots.\n"
     , "Filepath specified: " ++ T.unpack url
     ]