Skip to content

Commit bb15293

Browse files
mairawBillWagner
authored andcommitted
Fixed typos and other small things (dotnet#883)
* fix typos/style * readded missing line break * fixed typo * fixed headings * fixed typos
1 parent 6992d90 commit bb15293

File tree

14 files changed

+33
-35
lines changed

14 files changed

+33
-35
lines changed

docs/about/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ C#, F# and Visual Basic are popular languages that target and rely on the .NET p
2323

2424
There is great diversity across these languages, in philosophy and syntax, but also symmetry provided by a shared type system. This type system is provided by the underlying runtime environment. .NET was designed around the idea of a "common language runtime" that could support the requirements of diverse languages -- for example, dynamic and statically typed languages -- and enable interoperability between them. For example, it's possible to pass a collection of `People` objects between languages with no loss in semantics or capability.
2525

26-
Multiple [.NET implementations and products](products.md) are available, based on open [.NET Standards](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.md) that specify the fundamentals of the platform. They are separately optimized for different application types (for example, desktop, mobile, gaming, cloud) and support many chips (e.g. x86/x64, ARM) and operating systems (e.g. Windows, Linux, iOS, Android, macOS). Open source is also an important part of the .NET ecosystem, with multiple .NET implementations and many libraries available under OSI-approved licenses.
26+
Multiple [.NET implementations and products](products.md) are available, based on open [.NET Standards](https://github.com/dotnet/coreclr/blob/master/Documentation/project-docs/dotnet-standards.md) that specify the fundamentals of the platform. They are separately optimized for different application types (for example, desktop, mobile, gaming, cloud) and support many chips (for example, x86/x64, ARM) and operating systems (for example, Windows, Linux, iOS, Android, macOS). Open source is also an important part of the .NET ecosystem, with multiple .NET implementations and many libraries available under OSI-approved licenses.
2727

2828
- Learn about [.NET](../standard/index.md)
2929
- Learn about [C#](../csharp/index.md)
@@ -56,7 +56,7 @@ Features
5656
Open source
5757
-----------
5858

59-
The [.NET Core](https://github.com/dotnet/core) and [Mono](https://github.com/mono/mono) implementations of .NET are open source, using the MIT license. Documentation uses the [Creative Commons CC-BY](https://creativecommons.org/licenses/by/4.0/) license. .NET Core and Mono are sponsored by Microsoft and have many contributers from the community.
59+
The [.NET Core](https://github.com/dotnet/core) and [Mono](https://github.com/mono/mono) implementations of .NET are open source, using the MIT license. Documentation uses the [Creative Commons CC-BY](https://creativecommons.org/licenses/by/4.0/) license. .NET Core and Mono are sponsored by Microsoft and have many contributors from the community.
6060

6161
These general purpose runtimes can be used as the basis of academic research or teaching/learning or commercial products. Their open nature also means that anyone can contribute back to the upstream product code given a bug or the desire for a new feature.
6262

docs/about/products.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ You can build desktop apps for Windows and macOS.
3939

4040
### Games
4141

42-
You can build games for many desktop, mobile, console and virtual/agumented reality devices.
42+
You can build games for many desktop, mobile, console and virtual/augmented reality devices.
4343

4444
- [Unity](http://docs.unity3d.com/Manual/index.html) with [Mono](#mono)
4545
- [MonoGame](http://www.monogame.net/documentation/?page=main) with [Mono](#mono)
@@ -103,7 +103,7 @@ The .NET Framework is used to build apps for Windows and Windows Server. You can
103103

104104
[ASP.NET](http://www.asp.net/) is a web framework. It has several distinct pieces which are used to produce modern and high-performance web applications.
105105

106-
- [ASP.NET Web Forms](http://www.asp.net/web-forms) enables you to build a "forms over data" UI more radidly than most other Web technologies, with a designer that enables drag-and-drop of web controls.
106+
- [ASP.NET Web Forms](http://www.asp.net/web-forms) enables you to build a "forms over data" UI more rapidly than most other Web technologies, with a designer that enables drag-and-drop of web controls.
107107
- [ASP.NET MVC](http://www.asp.net/mvc) gives you greater control over the entire web pipeline, from the HTTP layer to the user interface.
108108
- [ASP.NET WebAPI](http://www.asp.net/web-api) is a convention-based framework for creating REST services.
109109
- [SignalR](http://www.asp.net/signalr) allows you to provide push-based communication to your web applications using the [WebSocket](https://en.wikipedia.org/wiki/WebSocket) protocol.

docs/core/deploying/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,4 +406,4 @@ The following is the complete `project.json` file for this project.
406406

407407
## <a name="crossgen"></a> Native image Generation ##
408408

409-
NET Core uses a just in time (JIT) compiler that stores application code in an intermediate format and compiles it to native code at runtime. To increase startup performance, the shared framework is pre-compiled using a tool called `crossgen`. To improve performance of your application, you can use the same tool on your application's binaries. Its performance impact is more noticeable when deploying a self-contained application, since the entire framework is part of the application. Crossgen must be run on a machine of the same platform type that you are targeting, but need not be done on the same machine, unlike ngen for the desktop framework. If you are producing a platform-specific installer for your application, we recomend that you crossgen as part of the installer build process.
409+
NET Core uses a just in time (JIT) compiler that stores application code in an intermediate format and compiles it to native code at runtime. To increase startup performance, the shared framework is pre-compiled using a tool called `crossgen`. To improve performance of your application, you can use the same tool on your application's binaries. Its performance impact is more noticeable when deploying a self-contained application, since the entire framework is part of the application. Crossgen must be run on a machine of the same platform type that you are targeting, but need not be done on the same machine, unlike ngen for the desktop framework. If you are producing a platform-specific installer for your application, we recommend that you crossgen as part of the installer build process.

docs/core/packages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ In most cases, you will not reference the lower-level .NET Core packages directl
6161
Metapackages are a NuGet package convention for describing a set of packages that are meaningful together. They represent this set of packages by making them dependencies. They can optionally establish a
6262
framework for this set of packages by specifying a framework.
6363

64-
By refg a metapackage, you are, in effect, adding a reference to each of its dependent packages as a single gesture. That means that all of the libraries in those packages (refs or libs) are available for IntelliSense (or similar experience) and for publishing (libs only) your app.
64+
By referencing a metapackage, you are, in effect, adding a reference to each of its dependent packages as a single gesture. That means that all of the libraries in those packages (refs or libs) are available for IntelliSense (or similar experience) and for publishing (libs only) your app.
6565

6666
Note: The 'lib' and 'ref' terms refer to folders in NuGet packages. 'ref' folders describe the public API of a package via assembly metadata. 'lib' folders contain the implementation of that public API for a given
6767
framework.

docs/core/tutorials/using-on-macos.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ tools, and incorporate third-party libraries via [NuGet](http://nuget.org).
2727
This article uses Visual Studio Code on Mac OS. Where there are differences,
2828
it points out the differences for the Windows platform.
2929

30-
Prerequisites
31-
-------------
30+
## Prerequisites
3231

3332
Before starting, you'll need to install the [.NET Core SDK](https://www.microsoft.com/net/core),
3433
currently in a preview release. The .NET Core SDK includes the latest release
@@ -40,8 +39,7 @@ that will improve the .NET Core development experience.
4039

4140
You can find the links to all of these at the [.NET home page](http://dot.net).
4241

43-
Getting Started
44-
---------------
42+
## Getting Started
4543

4644
The source for this tutorial is available on
4745
[GitHub](https://github.com/dotnet/core-docs/tree/master/samples/getting-started/golden).

docs/core/versions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The packages described by [NETStandard.Library](https://www.nuget.org/packages/N
6868

6969
### Metapackages
7070

71-
Versioning for .NET Core metapackages is based on the framework that they map to. The metapackages adopt the highest version number of the framework (for example, netstandard1.5) it maps to in its package closure.
71+
Versioning for .NET Core metapackages is based on the framework that they map to. The metapackages adopt the highest version number of the framework (for example, netstandard1.6) it maps to in its package closure.
7272

7373
The patch version for the metapackage is used to represent updates to the metapackage to reference updated packages. Patch versions will never include an updated framework version. As a result, the metapackages are not strictly SemVer compliant because their versioning scheme doesn't represent the degree of change in the underlying packages, but primarily the API level.
7474

docs/csharp/async.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ And that’s it! The code expresses the intent (downloading some data asynchrono
5252

5353
### CPU-bound Example: Performing a Calculation for a Game
5454

55-
Say you're writing a mobile game where pressing a button can inflict damage on many enemies on the screen. Performing the damage calcuation can be expensive, and doing it on the UI thread would make the game appear to pause as the calculation is performed!
55+
Say you're writing a mobile game where pressing a button can inflict damage on many enemies on the screen. Performing the damage calculation can be expensive, and doing it on the UI thread would make the game appear to pause as the calculation is performed!
5656

5757
The best way to handle this is to start a background thread which does the work using `Task.Run`, and `await` its result. This will allow the UI to feel smooth as the work is being done.
5858

@@ -121,7 +121,7 @@ The following examples demonstrate various ways you can write async code in C#.
121121

122122
This snippet downloads the HTML from www.dotnetfoundation.org and counts the number of times the string ".NET" occurs in the HTML. It uses ASP.NET MVC to define a web controller method which performs this task, returning the number.
123123

124-
*Note: you shouldn't ever use Regexes if you plan on doing actual HTML parsing. Please using a parsing library if this is your aim in production code.*
124+
*Note: you shouldn't ever use regular expressions if you plan on doing actual HTML parsing. Please using a parsing library if this is your aim in production code.*
125125

126126
```csharp
127127
private readonly HttpClient _httpClient = new HttpClient();

docs/csharp/delegate-class.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ have multiple target methods attached to a delegate object.
166166

167167
## Delegate and MulticastDelegate classes
168168

169-
The language support desccribed above provides the features
169+
The language support described above provides the features
170170
and support you'll typically need to work with delegates. These
171171
features are built on two classes in the .NET Core
172172
framework: @System.Delegate and @"System.MulticastDelegate".

docs/csharp/event-pattern.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ private void SearchDirectory(string directory, string searchPattern)
332332

333333
At this point, you can run the application calling the overload for
334334
searching all sub-directories. There are no subscribers on the new
335-
`OnChangeDirectory` event, but usingh the `?.Invoke()` idiom ensures
335+
`OnChangeDirectory` event, but using the `?.Invoke()` idiom ensures
336336
that this works correctly.
337337

338338
Let's add a handler to write a line that shows the progress in the

docs/csharp/indexers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ to indexers. The only exception to that rule is
5757
generate the correct storage for an indexer.
5858

5959
The presence of arguments to reference an item in a set of items distinguishes
60-
indexers from properties. You may define mulitple indexers on a type, as long
60+
indexers from properties. You may define multiple indexers on a type, as long
6161
as the argument lists for each indexer is unique. Let's explore different
6262
scenarios where you might use one or more indexers in a class definition.
6363

docs/csharp/iterators.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,14 +194,14 @@ private IEnumerable<int> IteratorMethod()
194194
```
195195

196196
Look at the methods above. The first uses the standard `return` statement to return
197-
either an empy collection, or the iterator created by the second method. The second
197+
either an empty collection, or the iterator created by the second method. The second
198198
method uses the `yield return` statement to create the requested sequence.
199199

200200
## Deeper Dive into `foreach`
201201

202202
The `foreach` statement expands into a standard idiom that uses the
203203
`IEnumable<T>` and `IEnumerator<T>` interfaces to iterate across all
204-
elements of a colleciton. It also minimizes errors developers make
204+
elements of a collection. It also minimizes errors developers make
205205
by not properly managing resources.
206206

207207
The compiler translates the `foreach` loop shown in the first

docs/standard/async-in-depth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ In the second example above, a `Task<T>` object will be returned from `GetString
7979

8080
After the System API call, the request is now in kernel space, making its way to the networking subsystem of the OS (such as `/net` in the Linux Kernel). Here the OS will handle the networking request *asynchronously*. Details may be different depending on the OS used (the device driver call may be scheduled as a signal sent back to the runtime, or a device driver call may be made and *then* a signal sent back), but eventually the runtime will be informed that the networking request is in progress. At this time, the work for the device driver will either be scheduled, in-progress, or already finished (the request is already out "over the wire") - but because this is all happening asynchronously, the device driver is able to immediately handle something else!
8181

82-
For example, in Windows an OS thread makes a call to the network device driver and asks it to perform the networking operation via an Interrupt Request Packet (IRP) which represents the operation. The device driver recieves the IRP, makes the call to the network, marks the IRP as "pending", and returns back to the OS. Because the OS thread now knows that the IRP is "pending", it doesn't have any more work to do for this job and "returns" back so that it can be used to perform other work.
82+
For example, in Windows an OS thread makes a call to the network device driver and asks it to perform the networking operation via an Interrupt Request Packet (IRP) which represents the operation. The device driver receives the IRP, makes the call to the network, marks the IRP as "pending", and returns back to the OS. Because the OS thread now knows that the IRP is "pending", it doesn't have any more work to do for this job and "returns" back so that it can be used to perform other work.
8383

8484
When the request is fulfilled and data comes back through the device driver, it notifies the CPU of new data received via an interrupt. How this interrupt gets handled will vary depending on the OS, but eventually the data will be passed through the OS until it reaches a system interop call (for example, in Linux an interrupt handler will schedule the bottom half of the IRQ to pass the data up through the OS asynchronously). Note that this *also* happens asynchronously! The result is queued up until the next available thread is able execute the async method and "unwrap" the result of the completed task.
8585

docs/standard/frameworks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You can refer to a framework or targeting of a framework using long- or short-fo
4949

5050
**Referring to a family of Frameworks**
5151

52-
You can refer to a family of frameworks using long- or short-forms of the framework ID. Bother are equally valid in the general case.
52+
You can refer to a family of frameworks using long- or short-forms of the framework ID. Both are equally valid in the general case.
5353

5454
- `.NETFramework`
5555
- `net`

styleguide/voice-tone.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Guidelines
1+
# Voice and tone guidelines
22

33
Developers will be reading your documents to learn .NET core, and to use it in their regular work.
44
Your goal is to create useful documentation that helps the reader on their journey. Our guidelines
55
help with that. Our style guide contains four recommendations:
66
- [Use a Conversational Tone](#use-a-conversational-tone)
7-
- [Write in 2nd Person](#write-in-2nd-person)
7+
- [Write in Second Person](#write-in-2nd-person)
88
- [Use Active Voice](#use-active-voice)
99
- [Target a 5th Grade Reading Level](#target-a-5th-grade-reading-level)
1010

@@ -13,16 +13,16 @@ following our guidelines to provide examples for you to follow as you build docu
1313
for .NET core. We also provide contrasting samples so you can see what articles look like
1414
when you don't follow our guidelines.
1515

16-
# Details on each guideline
16+
## Details on each guideline
1717

18-
## Use a Conversational Tone
19-
### Appropriate Style:
18+
### Use a Conversational Tone
19+
#### Appropriate Style:
2020
We want our documentation to have a conversational tone. You should feel as though you
2121
are having a conversation with the author as you read any of our tutorials or explanations.
2222
Your experience as a reader should be informal, conversational, and informative. You should
2323
feel as though you are listening to the author explain the concepts to you.
2424

25-
### Inappropriate Style:
25+
#### Inappropriate Style:
2626
One might see the contrast between a conversational style and the style one finds with
2727
more academic treatments of technical topics. Those resources are very useful, but the authors
2828
have written those articles in a very different style than our documentation. When one reads
@@ -32,26 +32,26 @@ One feels that they are reading a dry account of a very dry topic.
3232
The first paragraph above follows our recommendation conversational style. The second
3333
is a more academic style. You see the difference immediately.
3434

35-
## Write in 2nd person
36-
### Appropriate Style:
35+
### Write in second person
36+
#### Appropriate Style:
3737
You should write your articles as though you are speaking directly to the reader. You
3838
should use second person often (as I just have in these two sentences). 2nd person doesn't
3939
always mean using the word 'you'. Write directly to the reader. Write imperative sentences.
4040
Tell your reader what you want them to learn.
4141

42-
### Inappropriate Style:
43-
An author could also choose to write in 3rd person. In that model, an author must find some
44-
pronoun or noun to use when referring to the reader. A reader might often find this 3rd
42+
#### Inappropriate Style:
43+
An author could also choose to write in third person. In that model, an author must find some
44+
pronoun or noun to use when referring to the reader. A reader might often find this third
4545
person style less engaging and less enjoyable to read.
4646

47-
The first paragrah follows our recommended style. The second uses 3rd person. Please write
47+
The first paragraph follows our recommended style. The second uses third person. Please write
4848
in second person. You probably found that much easier to read.
4949

50-
## Use Active Voice
50+
### Use Active Voice
5151

5252
Write your articles in active voice. Active voice means that the subject of the sentence performs
5353
the action (verb) of that sentence. It contrasts with passive voice, where the sentence is arranged
54-
such that the subject of the sentence is acted upon. Constrast these two examples:
54+
such that the subject of the sentence is acted upon. Contrast these two examples:
5555

5656
>The compiler transformed source code into an executable.
5757
@@ -62,7 +62,7 @@ The first sentence uses active voice. The second sentence was written in passive
6262

6363
We recommend active voice because it is more readable. Passive voice can be more difficult to read.
6464

65-
## Target a 5th Grade Reading Level
65+
### Target a Fifth Grade Reading Level
6666

6767
We provide this final guideline because many of our readers are not native English speakers.
6868
You are reaching an international audience with your articles. Please take into account that

0 commit comments

Comments
 (0)