Skip to content

Commit 01e02b5

Browse files
0x6a62baronfel
authored andcommitted
fix documentation typos (#7420)
1 parent d982322 commit 01e02b5

10 files changed

Lines changed: 18 additions & 18 deletions

File tree

fcs/docsrc/content/caches.fsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This is a design note on the FSharpChecker component and its caches. See also t
99
Each FSharpChecker object maintains a set of caches. These are
1010
1111
* ``scriptClosureCache`` - an MRU cache of default size ``projectCacheSize`` that caches the
12-
computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transative closure
12+
computation of GetProjectOptionsFromScript. This computation can be lengthy as it can involve processing the transitive closure
1313
of all ``#load`` directives, which in turn can mean parsing an unbounded number of script files
1414
1515
* ``incrementalBuildersCache`` - an MRU cache of projects where a handle is being kept to their incremental checking state,
@@ -50,7 +50,7 @@ The sizes of some of these caches can be adjusted by giving parameters to FSharp
5050
the cache sizes above indicate the "strong" size of the cache, where memory is held regardless of the memory
5151
pressure on the system. Some of the caches can also hold "weak" references which can be collected at will by the GC.
5252
53-
> Note: Because of these caches, uou should generally use one global, shared FSharpChecker for everything in an IDE application.
53+
> Note: Because of these caches, you should generally use one global, shared FSharpChecker for everything in an IDE application.
5454
5555
5656
Low-Memory Condition

fcs/docsrc/content/compiler.fsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,14 @@ is not really an option.
8585
8686
You still have to pass the "-o" option to name the output file, but the output file is not actually written to disk.
8787
88-
The 'None' option indicates that the initiatlization code for the assembly is not executed.
88+
The 'None' option indicates that the initialization code for the assembly is not executed.
8989
*)
9090
let errors2, exitCode2, dynAssembly2 =
9191
checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], execute=None)
9292
|> Async.RunSynchronously
9393

9494
(*
95-
Passing 'Some' for the 'execute' parameter executes the initiatlization code for the assembly.
95+
Passing 'Some' for the 'execute' parameter executes the initialization code for the assembly.
9696
*)
9797
let errors3, exitCode3, dynAssembly3 =
9898
checker.CompileToDynamicAssembly([| "-o"; fn3; "-a"; fn2 |], Some(stdout,stderr))

fcs/docsrc/content/editor.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ list of members of the string value `msg`.
160160
161161
To do this, we call `GetDeclarationListInfo` with the location of the `.` symbol on the last line
162162
(ending with `printfn "%s" msg.`). The offsets are one-based, so the location is `7, 23`.
163-
We also need to specify a function that says that the text has not changed and the current identifer
163+
We also need to specify a function that says that the text has not changed and the current identifier
164164
where we need to perform the completion.
165165
*)
166166
// Get declarations (autocomplete) for a location

fcs/docsrc/content/interactive.fsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ open System
4343
open System.IO
4444
open System.Text
4545

46-
// Intialize output and input streams
47-
let sbOut = StringBuilder()
48-
let sbErr = StringBuilder()
46+
// Initialize output and input streams
47+
let sbOut = new StringBuilder()
48+
let sbErr = new StringBuilder()
4949
let inStream = new StringReader("")
5050
let outStream = new StringWriter(sbOut)
5151
let errStream = new StringWriter(sbErr)
@@ -121,7 +121,7 @@ result and an exception.
121121
122122
The result part of ``EvalExpression`` and ``EvalExpressionNonThrowing`` is an optional ``FSharpValue``.
123123
If that value is not present then it just indicates that the expression didn't have a tangible
124-
result that could be represented as a .NET object. This siutation shouldn't actually
124+
result that could be represented as a .NET object. This situation shouldn't actually
125125
occur for any normal input expressions, and only for primitives used in libraries.
126126
*)
127127

@@ -239,7 +239,7 @@ The 'fsi' object
239239
------------------
240240
241241
If you want your scripting code to be able to access the 'fsi' object, you should pass in an implementation of this object explicitly.
242-
Normally the one fromm FSharp.Compiler.Interactive.Settings.dll is used.
242+
Normally the one from FSharp.Compiler.Interactive.Settings.dll is used.
243243
*)
244244

245245
let fsiConfig2 = FsiEvaluationSession.GetDefaultConfiguration(fsiSession)

fcs/docsrc/content/project.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ F# projects normally use the '.fsproj' project file format.
314314
A project cracking facility for legacy old-style .fsproj is provided as a separate NuGet package:
315315
FSharp.Compiler.Service.ProjectCracker.
316316
317-
Projecet cracking for modern project files should be done using a library such as DotNetProjInfo.
317+
Project cracking for modern project files should be done using a library such as DotNetProjInfo.
318318
See FsAutoComplete for example code.
319319
320320
The legacy NuGet package `FSharp.Compiler.Service.ProjectCracker` contains a

fcs/docsrc/content/queue.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ These use cross-threaded access to the TAST data produced by other FSharpChecker
3636
Some tools throw a lot of interactive work at the FSharpChecker operations queue.
3737
If you are writing such a component, consider running your project against a debug build
3838
of FSharp.Compiler.Service.dll to see the Trace.WriteInformation messages indicating the length of the
39-
operations queuea and the time to process requests.
39+
operations queue and the time to process requests.
4040
4141
For those writing interactive editors which use FCS, you
4242
should be cautious about operations that request a check of the entire project.

fcs/docsrc/content/react.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ If your host happens to be Visual Studio, then this is one technique you can use
6767
6868
...
6969
70-
// Unadvise file changes...
70+
// Unadvised file changes...
7171
Com.ThrowOnFailure0(vsFileWatch.UnadviseFileChange(cookie))
7272
7373

fcs/docsrc/content/symbols.fsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Now get the value that corresponds to the function defined in the code:
101101
let fnVal = moduleEntity.MembersFunctionsAndValues.[0]
102102

103103
(**
104-
Now look around at the properties describing the function value. All fo the following evaluate to `true`:
104+
Now look around at the properties describing the function value. All of the following evaluate to `true`:
105105
*)
106106
fnVal.Attributes.Count = 1
107107
fnVal.CurriedParameterGroups.Count // 1
@@ -178,9 +178,9 @@ for assembly in projectContext.GetReferencedAssemblies() do
178178
(**
179179
**Notes:**
180180
181-
- If incomplete code is present, some or all of the attirbutes may not be quite as expected.
181+
- If incomplete code is present, some or all of the attributes may not be quite as expected.
182182
- If some assembly references are missing (which is actually very, very common), then 'IsUnresolved' may
183-
be true on values, members and/or entites related to external assemblies. You should be sure to make your
183+
be true on values, members and/or entities related to external assemblies. You should be sure to make your
184184
code robust against IsUnresolved exceptions.
185185
186186
*)

fcs/docsrc/content/tokenizer.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ on the `FSharpSourceTokenizer` object that we created earlier:
4949
let tokenizer = sourceTok.CreateLineTokenizer("let answer=42")
5050
(**
5151
Now, we can write a simple recursive function that calls `ScanToken` on the `tokenizer`
52-
until it returns `None` (indicating the end of line). When the function suceeds, it
52+
until it returns `None` (indicating the end of line). When the function succeeds, it
5353
returns `FSharpTokenInfo` object with all the interesting details:
5454
*)
5555
/// Tokenize a single line of F# code

fcs/docsrc/content/untypedtree.fsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ be another source of calls to `visitExpression`.
155155
### Walking over declarations
156156
157157
As mentioned earlier, the AST of a file contains a number of module or namespace declarations
158-
(top-level node) that contain declarations inside a module (let bindings or types) or inisde
158+
(top-level node) that contain declarations inside a module (let bindings or types) or inside
159159
a namespace (just types). The following functions walks over declarations - we ignore types,
160160
nested modules and all other elements and look only at top-level `let` bindings (values and
161161
functions):

0 commit comments

Comments
 (0)