Skip to content

Commit f3f45a0

Browse files
DanTupCommit Queue
authored andcommitted
[analysis_server] Fix some typos in readme/spec
Change-Id: Ifb14293a886eedd0ee868ac43ef18b6224967ac8 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/427740 Reviewed-by: Brian Wilkerson <[email protected]> Reviewed-by: Samuel Rawlins <[email protected]> Commit-Queue: Samuel Rawlins <[email protected]>
1 parent 29bc21c commit f3f45a0

File tree

13 files changed

+84
-84
lines changed

13 files changed

+84
-84
lines changed

pkg/analysis_server/doc/api.html

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ <h3>Communication Structure</h3>
181181
is the 'clientRequestTime' field, which is a number indicating
182182
the time at which the client made the request (milliseconds
183183
since epoch). Providing clientRequestTime helps us track
184-
how responsive analysis server is to client requests
184+
how responsive the analysis server is to client requests
185185
and better address any issues that occur.
186186
</p>
187187
<p>
@@ -247,7 +247,7 @@ <h3>Enumerations</h3>
247247
<h3>Changelog</h3>
248248
<h4>1.40.0</h4>
249249
<ul>
250-
<li>Added a an optional <tt>version</tt> field to <tt>AddContentOverlay</tt> and <tt>ChangeContentOverlay</tt> to allow clients/servers to have a way to identify specific versions of documents.</li>
250+
<li>Added an optional <tt>version</tt> field to <tt>AddContentOverlay</tt> and <tt>ChangeContentOverlay</tt> to allow clients/servers to have a way to identify specific versions of documents.</li>
251251
</ul>
252252
<h4>1.39.0</h4>
253253
<ul>
@@ -957,7 +957,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
957957
}
958958
}</pre></div>
959959
<p>
960-
Return the hover information associate with the given
960+
Return the hover information associated with the given
961961
location. If some or all of the hover information is not
962962
available at the time this request is processed the
963963
information will be omitted from the response.
@@ -1183,14 +1183,14 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
11831183
analysis roots is automatically updated, but the set of
11841184
requested analysis roots is unchanged. This means that if
11851185
the client sets an analysis root before the root becomes
1186-
visible to server in the filesystem, there is no error; once
1187-
the server sees the root in the filesystem it will start
1188-
analyzing it. Similarly, server will stop analyzing files
1186+
visible to the server in the filesystem, there is no error;
1187+
once the server sees the root in the filesystem it will start
1188+
analyzing it. Similarly, the server will stop analyzing files
11891189
that are removed from the file system but they will remain
11901190
in the set of requested roots.
11911191
</p>
11921192
<p>
1193-
If an included path represents a file, then server will look
1193+
If an included path represents a file, then the server will look
11941194
in the directory containing the file for a pubspec.yaml
11951195
file. If none is found, then the parents of the directory
11961196
will be searched until such a file is found or the root of
@@ -1364,7 +1364,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>subscriptions: Map&lt;<a href="#typ
13641364
previously updated but not included in this update remain
13651365
unchanged. This effectively represents an overlay of the
13661366
filesystem. The files whose content is overridden are
1367-
therefore seen by server as being files with the given
1367+
therefore seen by the server as being files with the given
13681368
content, even if the files do not exist on the filesystem or
13691369
if the file path represents the path to a directory on the
13701370
filesystem.
@@ -1449,7 +1449,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
14491449
<p>
14501450
Closing labels relevant to the file. Each item
14511451
represents a useful label associated with some range
1452-
with may be useful to display to the user within the editor
1452+
which may be useful to display to the user within the editor
14531453
at the end of the range to indicate what construct is closed
14541454
at that location. Closing labels include constructor/method
14551455
calls and List arguments that span multiple lines.
@@ -1604,7 +1604,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
16041604
</dd><dt class="field"><b>members: List&lt;<a href="#type_ImplementedMember">ImplementedMember</a>&gt;</b></dt><dd>
16051605

16061606
<p>
1607-
The member defined in the file that are implemented or overridden.
1607+
The members defined in the file that are implemented or overridden.
16081608
</p>
16091609
</dd></dl></dd><dt class="notification"><a name="notification_analysis.invalidate">analysis.invalidate</a></dt><dd><div class="box"><pre>notification: {
16101610
"event": "analysis.invalidate"
@@ -1968,8 +1968,8 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
19681968
<p>
19691969
The <tt>completion</tt> from the selected
19701970
<tt>CompletionSuggestion</tt>. It could be a name of a class, or a
1971-
name of a constructor in form "typeName.constructorName()", or an
1972-
enumeration constant in form "enumName.constantName", etc.
1971+
name of a constructor in the form "typeName.constructorName()", or an
1972+
enumeration constant in the form "enumName.constantName", etc.
19731973
</p>
19741974
</dd><dt class="field"><b>libraryUri: String</b></dt><dd>
19751975

@@ -2722,7 +2722,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
27222722
</dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></b></dt><dd>
27232723

27242724
<p>
2725-
The file edit that is to be applied to the given file to effect
2725+
The file edit that is to be applied to the given file to affect
27262726
the sorting.
27272727
</p>
27282728
</dd></dl></dd><dt class="request"><a name="request_edit.organizeDirectives">edit.organizeDirectives</a></dt><dd><div class="box"><pre>request: {
@@ -2765,7 +2765,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>file: <a href="#type_FilePath">File
27652765
</dd></dl><h4>returns:</h4><dl><dt class="field"><b>edit: <a href="#type_SourceFileEdit">SourceFileEdit</a></b></dt><dd>
27662766

27672767
<p>
2768-
The file edit that is to be applied to the given file to effect
2768+
The file edit that is to be applied to the given file to affect
27692769
the organizing.
27702770
</p>
27712771
</dd></dl></dd></dl>
@@ -2919,7 +2919,7 @@ <h4>parameters:</h4><dl><dt class="field"><b>code: String</b></dt><dd>
29192919
</dd></dl><h4>returns:</h4><dl><dt class="field"><b>suggestions: List&lt;<a href="#type_CompletionSuggestion">CompletionSuggestion</a>&gt;<span style="color:#999999"> (optional)</span></b></dt><dd>
29202920

29212921
<p>
2922-
The completion suggestions. In contrast to usual completion request,
2922+
The completion suggestions. In contrast to usual completion requests,
29232923
suggestions for private elements also will be provided.
29242924
</p>
29252925
<p>
@@ -3290,7 +3290,7 @@ <h2 class="domain"><a name="types">Types</a></h2>
32903290
</dd><dt class="field"><b>version: int<span style="color:#999999"> (optional)</span></b></dt><dd>
32913291

32923292
<p>An optional version number for the document. Version numbers allow the server to tag edits with the version of the document they apply to which can avoid applying edits to documents that have already been updated since the edits were computed.</p>
3293-
<p>If version numbers are supplied with AddContentOverlay and ChangeContentOverlay, they must be increasing (not not necessarily consecutive) numbers.</p>
3293+
<p>If version numbers are supplied with AddContentOverlay and ChangeContentOverlay, they must be increasing (but not necessarily consecutive) numbers.</p>
32943294
</dd></dl></dd><dt class="typeDefinition"><a name="type_AnalysisError">AnalysisError: object</a></dt><dd>
32953295
<p>
32963296
An indication of an error, warning, or hint that was produced by the
@@ -3523,7 +3523,7 @@ <h2 class="domain"><a name="types">Types</a></h2>
35233523
</dd><dt class="field"><b>version: int<span style="color:#999999"> (optional)</span></b></dt><dd>
35243524

35253525
<p>An optional version number for the document. Version numbers allow the server to tag edits with the version of the document they apply to which can avoid applying edits to documents that have already been updated since the edits were computed.</p>
3526-
<p>If version numbers are supplied with AddContentOverlay and ChangeContentOverlay, they must be increasing (not not necessarily consecutive) numbers.</p>
3526+
<p>If version numbers are supplied with AddContentOverlay and ChangeContentOverlay, they must be increasing (but not necessarily consecutive) numbers.</p>
35273527
</dd></dl></dd><dt class="typeDefinition"><a name="type_ClosingLabel">ClosingLabel: object</a></dt><dd>
35283528
<p>
35293529
A label that is associated with a range of code that may be useful to

pkg/analysis_server/lib/protocol/protocol_generated.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ class AnalysisClosingLabelsParams implements HasToJson {
126126
String file;
127127

128128
/// Closing labels relevant to the file. Each item represents a useful label
129-
/// associated with some range with may be useful to display to the user
129+
/// associated with some range which may be useful to display to the user
130130
/// within the editor at the end of the range to indicate what construct is
131131
/// closed at that location. Closing labels include constructor/method calls
132132
/// and List arguments that span multiple lines. Note that the ranges that
@@ -2262,7 +2262,7 @@ class AnalysisImplementedParams implements HasToJson {
22622262
/// The classes defined in the file that are implemented or extended.
22632263
List<ImplementedClass> classes;
22642264

2265-
/// The member defined in the file that are implemented or overridden.
2265+
/// The members defined in the file that are implemented or overridden.
22662266
List<ImplementedMember> members;
22672267

22682268
AnalysisImplementedParams(this.file, this.classes, this.members);
@@ -5205,8 +5205,8 @@ class CompletionGetSuggestionDetails2Params implements RequestParams {
52055205
int offset;
52065206

52075207
/// The `completion` from the selected `CompletionSuggestion`. It could be a
5208-
/// name of a class, or a name of a constructor in form
5209-
/// "typeName.constructorName()", or an enumeration constant in form
5208+
/// name of a class, or a name of a constructor in the form
5209+
/// "typeName.constructorName()", or an enumeration constant in the form
52105210
/// "enumName.constantName", etc.
52115211
String completion;
52125212

@@ -9288,7 +9288,7 @@ class EditOrganizeDirectivesParams implements RequestParams {
92889288
///
92899289
/// Clients may not extend, implement or mix-in this class.
92909290
class EditOrganizeDirectivesResult implements ResponseResult {
9291-
/// The file edit that is to be applied to the given file to effect the
9291+
/// The file edit that is to be applied to the given file to affect the
92929292
/// organizing.
92939293
SourceFileEdit edit;
92949294

@@ -9460,7 +9460,7 @@ class EditSortMembersParams implements RequestParams {
94609460
///
94619461
/// Clients may not extend, implement or mix-in this class.
94629462
class EditSortMembersResult implements ResponseResult {
9463-
/// The file edit that is to be applied to the given file to effect the
9463+
/// The file edit that is to be applied to the given file to affect the
94649464
/// sorting.
94659465
SourceFileEdit edit;
94669466

@@ -10430,7 +10430,7 @@ class ExecutionGetSuggestionsParams implements RequestParams {
1043010430
///
1043110431
/// Clients may not extend, implement or mix-in this class.
1043210432
class ExecutionGetSuggestionsResult implements ResponseResult {
10433-
/// The completion suggestions. In contrast to usual completion request,
10433+
/// The completion suggestions. In contrast to usual completion requests,
1043410434
/// suggestions for private elements also will be provided.
1043510435
///
1043610436
/// If there are sub-expressions that can have different runtime types, and

pkg/analysis_server/test/integration/support/integration_test_methods.dart

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,7 @@ abstract class IntegrationTest {
392392
);
393393
}
394394

395-
/// Return the hover information associate with the given location. If some
395+
/// Return the hover information associated with the given location. If some
396396
/// or all of the hover information is not available at the time this request
397397
/// is processed the information will be omitted from the response.
398398
///
@@ -712,12 +712,12 @@ abstract class IntegrationTest {
712712
/// filesystem. When the filesystem changes, the actual set of analysis roots
713713
/// is automatically updated, but the set of requested analysis roots is
714714
/// unchanged. This means that if the client sets an analysis root before the
715-
/// root becomes visible to server in the filesystem, there is no error; once
716-
/// the server sees the root in the filesystem it will start analyzing it.
717-
/// Similarly, server will stop analyzing files that are removed from the
718-
/// file system but they will remain in the set of requested roots.
715+
/// root becomes visible to the server in the filesystem, there is no error;
716+
/// once the server sees the root in the filesystem it will start analyzing
717+
/// it. Similarly, the server will stop analyzing files that are removed from
718+
/// the file system but they will remain in the set of requested roots.
719719
///
720-
/// If an included path represents a file, then server will look in the
720+
/// If an included path represents a file, then the server will look in the
721721
/// directory containing the file for a pubspec.yaml file. If none is found,
722722
/// then the parents of the directory will be searched until such a file is
723723
/// found or the root of the file system is reached. If such a file is found,
@@ -860,9 +860,9 @@ abstract class IntegrationTest {
860860
/// Update the content of one or more files. Files that were previously
861861
/// updated but not included in this update remain unchanged. This
862862
/// effectively represents an overlay of the filesystem. The files whose
863-
/// content is overridden are therefore seen by server as being files with
864-
/// the given content, even if the files do not exist on the filesystem or if
865-
/// the file path represents the path to a directory on the filesystem.
863+
/// content is overridden are therefore seen by the server as being files
864+
/// with the given content, even if the files do not exist on the filesystem
865+
/// or if the file path represents the path to a directory on the filesystem.
866866
///
867867
/// Parameters
868868
///
@@ -946,7 +946,7 @@ abstract class IntegrationTest {
946946
/// labels: List<ClosingLabel>
947947
///
948948
/// Closing labels relevant to the file. Each item represents a useful
949-
/// label associated with some range with may be useful to display to the
949+
/// label associated with some range which may be useful to display to the
950950
/// user within the editor at the end of the range to indicate what
951951
/// construct is closed at that location. Closing labels include
952952
/// constructor/method calls and List arguments that span multiple lines.
@@ -1076,7 +1076,7 @@ abstract class IntegrationTest {
10761076
///
10771077
/// members: List<ImplementedMember>
10781078
///
1079-
/// The member defined in the file that are implemented or overridden.
1079+
/// The members defined in the file that are implemented or overridden.
10801080
late final Stream<AnalysisImplementedParams> onAnalysisImplemented =
10811081
_onAnalysisImplemented.stream.asBroadcastStream();
10821082

@@ -1376,8 +1376,8 @@ abstract class IntegrationTest {
13761376
/// completion: String
13771377
///
13781378
/// The `completion` from the selected `CompletionSuggestion`. It could be
1379-
/// a name of a class, or a name of a constructor in form
1380-
/// "typeName.constructorName()", or an enumeration constant in form
1379+
/// a name of a class, or a name of a constructor in the form
1380+
/// "typeName.constructorName()", or an enumeration constant in the form
13811381
/// "enumName.constantName", etc.
13821382
///
13831383
/// libraryUri: String
@@ -2376,7 +2376,7 @@ abstract class IntegrationTest {
23762376
///
23772377
/// edit: SourceFileEdit
23782378
///
2379-
/// The file edit that is to be applied to the given file to effect the
2379+
/// The file edit that is to be applied to the given file to affect the
23802380
/// sorting.
23812381
Future<EditSortMembersResult> sendEditSortMembers(String file) async {
23822382
var params = EditSortMembersParams(
@@ -2414,7 +2414,7 @@ abstract class IntegrationTest {
24142414
///
24152415
/// edit: SourceFileEdit
24162416
///
2417-
/// The file edit that is to be applied to the given file to effect the
2417+
/// The file edit that is to be applied to the given file to affect the
24182418
/// organizing.
24192419
Future<EditOrganizeDirectivesResult> sendEditOrganizeDirectives(
24202420
String file,
@@ -2540,7 +2540,7 @@ abstract class IntegrationTest {
25402540
///
25412541
/// suggestions: List<CompletionSuggestion> (optional)
25422542
///
2543-
/// The completion suggestions. In contrast to usual completion request,
2543+
/// The completion suggestions. In contrast to usual completion requests,
25442544
/// suggestions for private elements also will be provided.
25452545
///
25462546
/// If there are sub-expressions that can have different runtime types, and

pkg/analysis_server/tool/lsp_spec/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ The following custom fields/methods/notifications are also provided by the Dart
158158

159159
### Message.clientRequestTime Field
160160

161-
The server accepts an optional `int?` on all incoming messages named `clientRequestTime` (alongside `id`, `method`, `params`) containing a timestamp (milliseconds since epoch) of when the client made that request. Providing clientRequestTime helps track how responsive analysis server is to client requests and better address any issues that occur.
161+
The server accepts an optional `int?` on all incoming messages named `clientRequestTime` (alongside `id`, `method`, `params`) containing a timestamp (milliseconds since epoch) of when the client made that request. Providing `clientRequestTime` helps track how responsive the analysis server is to client requests and better address any issues that occur.
162162

163163
### dart/diagnosticServer Method
164164

0 commit comments

Comments
 (0)