Skip to content

Commit f37479a

Browse files
authored
Lots of doc typo updates (#50)
1 parent ab62e2f commit f37479a

File tree

84 files changed

+204
-191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+204
-191
lines changed

Samples/Kaleidoscope/Chapter2/CodeGenerator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313

1414
namespace Kaleidoscope
1515
{
16-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
16+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
1717
/// <remarks>
1818
/// This doesn't actually generate any code. The only thing it does is to record any user defined operators
19-
/// in the <see cref="DynamicRuntimeState"/> so that subsequent parsing takes the operator precednece into
19+
/// in the <see cref="DynamicRuntimeState"/> so that subsequent parsing takes the operator precedence into
2020
/// account. (If the language didn't support user defined precedence this would not be needed at all)
2121
/// </remarks>
2222
internal sealed class CodeGenerator

Samples/Kaleidoscope/Chapter3/CodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
namespace Kaleidoscope
2222
{
23-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
23+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2424
internal sealed class CodeGenerator
2525
: KaleidoscopeBaseVisitor<Value>
2626
, IDisposable

Samples/Kaleidoscope/Chapter4/CodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
namespace Kaleidoscope
2323
{
24-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
24+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2525
internal sealed class CodeGenerator
2626
: KaleidoscopeBaseVisitor<Value>
2727
, IDisposable

Samples/Kaleidoscope/Chapter6/CodeGenerator.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
namespace Kaleidoscope
2323
{
24-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
24+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2525
internal sealed class CodeGenerator
2626
: KaleidoscopeBaseVisitor<Value>
2727
, IDisposable
@@ -290,7 +290,7 @@ public override Value VisitForExpression( [NotNull] ForExpressionContext context
290290
InstructionBuilder.Branch( endCondition, loopBlock, afterBlock );
291291
InstructionBuilder.PositionAtEnd( afterBlock );
292292

293-
// Add a new entry to the PHI node for the backedge.
293+
// Add a new entry to the PHI node for the back-edge.
294294
variable.AddIncoming( nextVar, loopEndBlock );
295295

296296
// for expr always returns 0.0 for consistency, there is no 'void'

Samples/Kaleidoscope/Chapter7/CodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222
namespace Kaleidoscope
2323
{
24-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
24+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2525
internal sealed class CodeGenerator
2626
: KaleidoscopeBaseVisitor<Value>
2727
, IDisposable

Samples/Kaleidoscope/Chapter8/CodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
namespace Kaleidoscope
2020
{
21-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
21+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2222
internal sealed class CodeGenerator
2323
: KaleidoscopeBaseVisitor<Value>
2424
, IDisposable

Samples/Kaleidoscope/Chapter9/CodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
namespace Kaleidoscope
2222
{
23-
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaledoscope AST</summary>
23+
/// <summary>Static extension methods to perform LLVM IR Code generation from the Kaleidoscope AST</summary>
2424
internal sealed class CodeGenerator
2525
: KaleidoscopeBaseVisitor<Value>
2626
, IDisposable

Samples/Kaleidoscope/Kaleidoscope.Runtime/IKaleidoscopeCodeGenerator.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public interface IKaleidoscopeCodeGenerator<TResult>
4747
/// <returns>Generated result</returns>
4848
/// <remarks>
4949
/// The behavior of this method depends on the implementation. The common case is to
50-
/// actally generate an LLVM module for the JIT engine. Normally, any anonymous expressions
50+
/// actually generate an LLVM module for the JIT engine. Normally, any anonymous expressions
5151
/// (<see cref="Kaleidoscope.Grammar.KaleidoscopeParser.TopLevelExpressionContext"/>) are
5252
/// JIT compiled and executed. The result of executing the expression is returned.
5353
/// For Function definitions or declarations, the <see cref="Llvm.NET.Values.Function"/> is returned.

Samples/Kaleidoscope/Kaleidoscope.Runtime/KaleidoscopeJIT.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace Kaleidoscope.Runtime
1111
{
12-
/// <summary>JIT engine for Kaledoscope language</summary>
12+
/// <summary>JIT engine for Kaleidoscope language</summary>
1313
public sealed class KaleidoscopeJIT
1414
: IDisposable
1515
{

Samples/Kaleidoscope/Kaleidoscope.Runtime/ReplErrorStrategy.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace Kaleidoscope.Runtime
99
/// <summary>Error handling strategy for REPL scenarios</summary>
1010
/// <remarks>
1111
/// This strategy handles creating more meaningful messages on feature predicate failures.
12-
/// Additionally, error recovery that results from reaching EOF on an otherwise succesful parse
12+
/// Additionally, error recovery that results from reaching EOF on an otherwise successful parse
1313
/// is translated into a <see cref="ParseCanceledException"/> to prevent any further attempts
1414
/// at recovery. This allows for detection of the incomplete statements when used in an interactive
1515
/// REPL application. In such a case the incomplete code could be combined with new text from the

0 commit comments

Comments
 (0)