You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Small fixes to FCS members' documentation (dotnet#2433)
* Documentation of textSnapshotInfo parameter now mentions that hasTextChangedSinceLastTypecheck is something made available in some members FSharpCheckFileResults.* remove parameter documentation for gone isResultObsolete parameter
Copy file name to clipboardExpand all lines: src/fsharp/vs/service.fsi
+5-17Lines changed: 5 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -415,12 +415,8 @@ type internal FSharpChecker =
415
415
/// <param name="fileversion">An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file.</param>
416
416
/// <param name="source">The full source for the file.</param>
417
417
/// <param name="options">The options for the project or script.</param>
418
-
/// <param name="isResultObsolete">
419
-
/// A callback to check if a requested result is already obsolete, e.g. because of changed
420
-
// source code in the editor. Type checking is abandoned when this returns 'true'.
421
-
/// </param>
422
418
/// <param name="textSnapshotInfo">
423
-
/// An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if
419
+
/// An item passed back to 'hasTextChangedSinceLastTypecheck'(from some calls made on 'FSharpCheckFileResults')to help determine if
424
420
/// an approximate intellisense resolution is inaccurate because a range of text has changed. This
425
421
/// can be used to marginally increase accuracy of intellisense results in some situations.
426
422
/// </param>
@@ -436,7 +432,7 @@ type internal FSharpChecker =
436
432
///</para>
437
433
///<para>
438
434
/// Return FSharpCheckFileAnswer.Aborted if a parse tree was not available or if the check
439
-
//// was abandoned due toisResultObsolete returning 'true' atsome checkpoint during type checking.
435
+
//// was abandoned due to some checkpoint during type checking.
440
436
///</para>
441
437
///</summary>
442
438
///
@@ -445,12 +441,8 @@ type internal FSharpChecker =
445
441
/// <param name="fileversion">An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file.</param>
446
442
/// <param name="source">The full source for the file.</param>
447
443
/// <param name="options">The options for the project or script.</param>
448
-
/// <param name="isResultObsolete">
449
-
/// A callback to check if a requested result is already obsolete, e.g. because of changed
450
-
// source code in the editor. Type checking is abandoned when this returns 'true'.
451
-
/// </param>
452
444
/// <param name="textSnapshotInfo">
453
-
/// An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if
445
+
/// An item passed back to 'hasTextChangedSinceLastTypecheck'(from some calls made on 'FSharpCheckFileResults')to help determine if
454
446
/// an approximate intellisense resolution is inaccurate because a range of text has changed. This
455
447
/// can be used to marginally increase accuracy of intellisense results in some situations.
456
448
/// </param>
@@ -466,20 +458,16 @@ type internal FSharpChecker =
466
458
///</para>
467
459
///<para>
468
460
/// Return FSharpCheckFileAnswer.Aborted if a parse tree was not available or if the check
469
-
//// was abandoned due toisResultObsolete returning 'true' atsome checkpoint during type checking.
461
+
//// was abandoned due to some checkpoint during type checking.
/// <param name="fileversion">An integer that can be used to indicate the version of the file. This will be returned by TryGetRecentCheckResultsForFile when looking up the file.</param>
475
467
/// <param name="source">The full source for the file.</param>
476
468
/// <param name="options">The options for the project or script.</param>
477
-
/// <param name="isResultObsolete">
478
-
/// A callback to check if a requested result is already obsolete, e.g. because of changed
479
-
// source code in the editor. Type checking is abandoned when this returns 'true'.
480
-
/// </param>
481
469
/// <param name="textSnapshotInfo">
482
-
/// An item passed back to 'hasTextChangedSinceLastTypecheck' to help determine if
470
+
/// An item passed back to 'hasTextChangedSinceLastTypecheck'(from some calls made on 'FSharpCheckFileResults')to help determine if
483
471
/// an approximate intellisense resolution is inaccurate because a range of text has changed. This
484
472
/// can be used to marginally increase accuracy of intellisense results in some situations.