[Repo Assist] Improve Literate.ParseAndCheckScriptFile/ParseScriptString XML docs; fix Windows-only path fallback (#1091)

* Add XML doc comments to Literate.ParseAndCheckScriptFile/ParseScriptString; fix Windows-only path fallback

- Add full <summary>/<param> XML doc comments to ParseAndCheckScriptFile and
  ParseScriptString to be consistent with the other Literate.Parse* methods
  which already have detailed documentation.
- Fix hardcoded "C:\script.fsx" fallback path (used when neither 'path' nor
  'rootInputFolder' is supplied) in ParseScriptString and ParsePynbString.
  The fallback is now simply "script.fsx" so it looks correct on Linux/macOS
  in diagnostic messages.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* ci: trigger checks

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Don Syme <dsyme@users.noreply.github.com>

Author: 3 people

RELEASE_NOTES.md

@@ -10,6 +10,10 @@
 * `fsdocs convert` now accepts the input file as a positional argument (e.g. `fsdocs convert notebook.ipynb -o notebook.html`). [#1019](https://github.com/fsprojects/FSharp.Formatting/pull/1019)
 * `fsdocs convert` infers the output format from the output file extension when `--outputformat` is not specified (e.g. `-o out.md` implies `--outputformat markdown`). [#1019](https://github.com/fsprojects/FSharp.Formatting/pull/1019)
 * `fsdocs convert` now accepts `-o` as a shorthand for `--output`. [#1019](https://github.com/fsprojects/FSharp.Formatting/pull/1019)
+* Added full XML doc comments (`<summary>`, `<param>`) to `Literate.ParseAndCheckScriptFile` and `Literate.ParseScriptString` to match the documentation style of the other `Literate.Parse*` methods.
+
+### Fixed
+* `Literate.ParseScriptString` and `Literate.ParsePynbString` used a hardcoded Windows path (`C:\script.fsx`) as the fallback script filename when neither `path` nor `rootInputFolder` is supplied. The fallback is now a simple platform-neutral `script.fsx`.
 * Add regression tests for cross-assembly tooltip resolution (issue [#1085](https://github.com/fsprojects/FSharp.Formatting/issues/1085)): verify that hover tooltips for types whose fields reference types from other assemblies show the correct type names (not `obj`) when `#r` paths resolve correctly.
 
 ### Changed

src/FSharp.Formatting.Literate/Literate.fs

@@ -98,7 +98,18 @@ type Literate private () =
 
             doc.With(paragraphs = pars)
 
-    /// Parse F# Script file to LiterateDocument
+    /// <summary>
+    /// Parse an F# script file (<c>.fsx</c>) to a <see cref="T:FSharp.Formatting.Literate.LiterateDocument"/>,
+    /// type-checking it via the F# Compiler Service.
+    /// </summary>
+    /// <param name="path">The path to the <c>.fsx</c> script file to parse.</param>
+    /// <param name="fscOptions">Additional F# compiler options (e.g. extra <c>-r:</c> references).</param>
+    /// <param name="definedSymbols">Conditional-compilation symbols to define.</param>
+    /// <param name="references">A map of reference labels to URLs, used to resolve Markdown-style links.</param>
+    /// <param name="fsiEvaluator">An optional FSI evaluator; when supplied, code snippets are executed and their output included.</param>
+    /// <param name="parseOptions">Markdown parse options. Defaults to <see cref="F:FSharp.Formatting.Markdown.MarkdownParseOptions.AllowYamlFrontMatter"/>.</param>
+    /// <param name="rootInputFolder">The root folder used to resolve relative paths within the script. Defaults to the directory containing <paramref name="path"/>.</param>
+    /// <param name="onError">A callback invoked with each error/warning message encountered during parsing or type-checking. Defaults to <c>ignore</c>.</param>
     static member ParseAndCheckScriptFile
         (
             path: string,
@@ -120,7 +131,20 @@ type Literate private () =
         |> Transformations.formatCodeSnippets path ctx
         |> Transformations.evaluateCodeSnippets ctx
 
-    /// Parse string as F# Script to LiterateDocument
+    /// <summary>
+    /// Parse a string containing F# script source code (<c>.fsx</c> syntax) to a
+    /// <see cref="T:FSharp.Formatting.Literate.LiterateDocument"/>,
+    /// type-checking it via the F# Compiler Service.
+    /// </summary>
+    /// <param name="content">The F# script source code to parse.</param>
+    /// <param name="path">An optional file path used in diagnostics and to resolve relative references. When not supplied, defaults to <c>script.fsx</c> in <paramref name="rootInputFolder"/> (or just <c>script.fsx</c>).</param>
+    /// <param name="fscOptions">Additional F# compiler options (e.g. extra <c>-r:</c> references).</param>
+    /// <param name="definedSymbols">Conditional-compilation symbols to define.</param>
+    /// <param name="references">A map of reference labels to URLs, used to resolve Markdown-style links.</param>
+    /// <param name="fsiEvaluator">An optional FSI evaluator; when supplied, code snippets are executed and their output included.</param>
+    /// <param name="parseOptions">Markdown parse options. Defaults to <see cref="F:FSharp.Formatting.Markdown.MarkdownParseOptions.AllowYamlFrontMatter"/>.</param>
+    /// <param name="rootInputFolder">The root folder used to resolve relative paths within the script.</param>
+    /// <param name="onError">A callback invoked with each error/warning message encountered during parsing or type-checking. Defaults to <c>ignore</c>.</param>
     static member ParseScriptString
         (
             content,
@@ -141,7 +165,7 @@ type Literate private () =
             | Some s -> s
             | None ->
                 match rootInputFolder with
-                | None -> "C:\\script.fsx"
+                | None -> "script.fsx"
                 | Some r -> Path.Combine(r, "script.fsx")
 
         ParseScript(parseOptions, ctx).ParseAndCheckScriptFile(filePath, content, rootInputFolder, onError)
@@ -242,7 +266,7 @@ type Literate private () =
             | Some s -> s
             | None ->
                 match rootInputFolder with
-                | None -> "C:\\script.fsx"
+                | None -> "script.fsx"
                 | Some r -> Path.Combine(r, "script.fsx")
 
         let content = ParsePynb.pynbStringToFsx content