Skip to content

Commit 5dac4d1

Browse files
baywetCopilot
andauthored
docs: Update XML remarks for OpenApiModelFactory
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 53acb46 commit 5dac4d1

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

src/Microsoft.OpenApi/Reader/OpenApiModelFactory.cs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -204,10 +204,11 @@ public static async Task<ReadResult> LoadAsync(Stream input, string? format = nu
204204
/// <param name="format">The Open API format</param>
205205
/// <param name="settings">The OpenApi reader settings.</param>
206206
/// <returns>An OpenAPI document instance.</returns>
207-
/// <remarks>
208-
/// OpenAPI semantic and parser errors are returned in the <see cref="ReadResult.Diagnostic"/>.
209-
/// <see cref="ArgumentException"/> is thrown when <paramref name="input"/> is null or empty before parsing starts.
210-
/// </remarks>
207+
/// <remarks>
208+
/// OpenAPI semantic errors and parser errors that can be represented in the <see cref="ReadResult.Diagnostic"/> are returned.
209+
/// Parser failures that occur before a result can be created may throw.
210+
/// <see cref="ArgumentException"/> is thrown when <paramref name="input"/> is null or empty before parsing starts.
211+
/// </remarks>
211212
public static ReadResult Parse(string input,
212213
string? format = null,
213214
OpenApiReaderSettings? settings = null)

0 commit comments

Comments
 (0)