Merge pull request #751 from dsyme/fix

Fix problem with doc scripts
fsprojects · Jun 7, 2022 · 68f9314 · 68f9314
2 parents f389c0d + 139754a
commit 68f9314
Show file tree

Hide file tree

Showing 19 changed files with 97 additions and 107 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -15,7 +15,7 @@
       ]
     },
     "fantomas": {
-      "version": "5.0.0-alpha-007",
+      "version": "5.0.0-alpha-008",
       "commands": [
         "fantomas"
       ]

diff --git a/.fantomasignore b/.fantomasignore
@@ -0,0 +1,2 @@
+docs/*.fsx
+paket-files/
diff --git a/docs/apidocs.fsx b/docs/apidocs.fsx
@@ -16,11 +16,11 @@ index: 5
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 (*** hide ***)
 let root = "C:\\"

diff --git a/docs/codeformat.fsx b/docs/codeformat.fsx
@@ -15,11 +15,11 @@ index: 1
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 (**
 [![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;

diff --git a/docs/content.fsx b/docs/content.fsx
@@ -15,11 +15,11 @@ index: 3
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 
 (**

diff --git a/docs/evaluation.fsx b/docs/evaluation.fsx
@@ -15,11 +15,11 @@ index: 6
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 (**
 [![Binder](img/badge-binder.svg)](https://mybinder.org/v2/gh/fsprojects/fsharp.formatting/gh-pages?filepath={{fsdocs-source-basename}}.ipynb)&emsp;

diff --git a/docs/literate.fsx b/docs/literate.fsx
@@ -15,11 +15,11 @@ index: 3
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 
 (**

diff --git a/docs/markdown.fsx b/docs/markdown.fsx
@@ -12,11 +12,11 @@ index: 2
 (*** condition: fsx ***)
 #if FSX
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // FSX
 (*** condition: ipynb ***)
 #if IPYNB
 #r "nuget: FSharp.Formatting,{{fsdocs-package-version}}"
-#endif
+#endif // IPYNB
 
 
 (**

diff --git a/src/FSharp.Formatting.ApiDocs/GenerateModel.fs b/src/FSharp.Formatting.ApiDocs/GenerateModel.fs
@@ -731,8 +731,8 @@ module internal CrossReferences =
         | "" ->
             try
                 defaultArg (Option.map (sprintf "T:%s") typ.TryFullName) ""
-            with
-            | _ -> ""
+            with _ ->
+                ""
         | n -> n
 
     let getMemberXmlDocsSigPrefix (memb: FSharpMemberOrFunctionOrValue) =
@@ -784,8 +784,7 @@ module internal CrossReferences =
                             ""
 
                     sprintf "%s%s%s" name typeArgs paramList
-                with
-                | exn ->
+                with exn ->
                     printfn "Error while building fsdocs-member-name for %s because: %s" memb.FullName exn.Message
                     Log.verbf "Full Exception details of previous message: %O" exn
                     memb.CompiledName
@@ -1603,8 +1602,8 @@ module internal SymbolReader =
                         v.ApparentEnclosingEntity,
                         formatTyconRefAsHtml ctx.UrlMap v.ApparentEnclosingEntity |> codeHtml
                     )
-                with
-                | _ -> None
+                with _ ->
+                    None
             else
                 None
 
@@ -2387,8 +2386,8 @@ module internal SymbolReader =
                 | Let "1000" (idx, _) ->
                     (try
                         int idx
-                     with
-                     | _ -> Int32.MaxValue)
+                     with _ ->
+                         Int32.MaxValue)
 
             let exclude =
                 match cmds with
@@ -2398,26 +2397,23 @@ module internal SymbolReader =
 
             try
                 Some(f cat catindex exclude cmds comment, nsdocs)
-            with
-            | e ->
+            with e ->
                 let name =
                     try
                         sym.FullName
-                    with
-                    | _ ->
+                    with _ ->
                         try
                             sym.DisplayName
-                        with
-                        | _ ->
+                        with _ ->
                             let part =
                                 try
                                     let ass = sym.Assembly
 
                                     match ass.FileName with
                                     | Some file -> file
                                     | None -> ass.QualifiedName
-                                with
-                                | _ -> "unknown"
+                                with _ ->
+                                    "unknown"
 
                             sprintf "unknown, part of %s" part
 

diff --git a/src/FSharp.Formatting.CodeFormat/Pervasive.fs b/src/FSharp.Formatting.CodeFormat/Pervasive.fs
@@ -157,8 +157,8 @@ type FSharpChecker with
                     let! worker = Async.StartChild(parseAndCheckFile, 2000)
                     let! result = worker
                     return Ready result
-                with
-                | :? TimeoutException -> return StillRunning parseAndCheckFile
+                with :? TimeoutException ->
+                    return StillRunning parseAndCheckFile
             }
 
         let bindParsedInput (results: (FSharpParseFileResults * FSharpCheckFileResults) option) =

diff --git a/src/FSharp.Formatting.Common/Templating.fs b/src/FSharp.Formatting.Common/Templating.fs
@@ -195,7 +195,7 @@ module internal SimpleTemplating =
             let path = Path.GetFullPath(outputFile) |> Path.GetDirectoryName
 
             Directory.CreateDirectory(path) |> ignore
-        with
-        | _ -> ()
+        with _ ->
+            ()
 
         File.WriteAllText(outputFile, outputText)
diff --git a/src/FSharp.Formatting.Common/YaafFSharpScripting.fs b/src/FSharp.Formatting.Common/YaafFSharpScripting.fs
@@ -925,8 +925,7 @@ type internal FsiSession
 
                 saveOutput () |> ignore
                 session)
-        with
-        | e ->
+        with e ->
             let err, out, _ = getMessages ()
 
             raise
@@ -943,8 +942,7 @@ type internal FsiSession
             redirectOut (fun () ->
                 let res = f text
                 saveOutput (), res)
-        with
-        | e ->
+        with e ->
             let err, out, inp = getMessages ()
 
             raise

diff --git a/src/FSharp.Formatting.Literate/Evaluator.fs b/src/FSharp.Formatting.Literate/Evaluator.fs
@@ -377,8 +377,8 @@ module __FsiSettings =
         if depth > 20 then
             try
                 sprintf "%A" v
-            with
-            | e -> e.ToString()
+            with e ->
+                e.ToString()
         else
             plainTextPrinters
             // Try to find a printer or print transformer
@@ -387,21 +387,21 @@ module __FsiSettings =
                 | Choice1Of2 addedPrinter ->
                     try
                         addedPrinter v
-                    with
-                    | _ -> None
+                    with _ ->
+                        None
                 | Choice2Of2 addedPrintTransformer ->
                     (try
                         addedPrintTransformer v
-                     with
-                     | _ -> None)
+                     with _ ->
+                         None)
                     |> Option.map (plainTextPrint (depth + 1)))
             |> function
                 | None ->
                     // no printer found
                     try
                         sprintf "%A" v
-                    with
-                    | e -> e.ToString()
+                    with e ->
+                        e.ToString()
                 | Some t -> t
 
     let rec tryHtmlPrint depth (v: obj) =
@@ -415,13 +415,13 @@ module __FsiSettings =
                 | Choice1Of2 addedPrinter ->
                     try
                         addedPrinter v
-                    with
-                    | _ -> None
+                    with _ ->
+                        None
                 | Choice2Of2 addedPrintTransformer ->
                     (try
                         addedPrintTransformer v
-                     with
-                     | _ -> None)
+                     with _ ->
+                         None)
                     |> Option.bind (tryHtmlPrint (depth + 1)))
 
     /// Registered transformations for pretty printing values
@@ -555,8 +555,7 @@ module __FsiSettings =
                           Result = value
                           ItValue = itvalue }
                         :> IFsiEvaluationResult)
-            with
-            | :? FsiEvaluationException as e ->
+            with :? FsiEvaluationException as e ->
                 evalFailed.Trigger
                     { File = file
                       AsExpression = asExpression