Skip to content

Commit 82c31f1

Browse files
authored
docs: Run *.md documents through Grammer.ly (#757)
1 parent 7b399a0 commit 82c31f1

File tree

8 files changed

+57
-58
lines changed

8 files changed

+57
-58
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,11 +215,11 @@ All notable changes to this project will be documented in this file.
215215
- [PR #518](https://github.com/sendgrid/sendgrid-csharp/pull/518) README improvements. Big thanks to [Matt Bernier](https://github.com/mbernier) for the PR!
216216

217217
## Fixed
218-
- [PR #735](https://github.com/sendgrid/sendgrid-csharp/pull/735) Fix #418 groupsToDisplay shold be optional.
219-
- [PR #719](https://github.com/sendgrid/sendgrid-csharp/pull/719) Update travis config to use relative path. Big thanks to [Maxim Rubis](https://github.com/siburny) for the PR!
218+
- [PR #735](https://github.com/sendgrid/sendgrid-csharp/pull/735) Fix #418 groupsToDisplay should be optional.
219+
- [PR #719](https://github.com/sendgrid/sendgrid-csharp/pull/719) Update travis config to use a relative path. Big thanks to [Maxim Rubis](https://github.com/siburny) for the PR!
220220
- [PR #702](https://github.com/sendgrid/sendgrid-csharp/pull/702) Fixed virtual bug. Big thanks to [Phil](https://github.com/psboies) for the PR!
221221
- [PR #700](https://github.com/sendgrid/sendgrid-csharp/pull/700) Add default value for SubstitutionTag parameter. Big thanks to [Vedant Koditkar](https://github.com/KoditkarVedant) for the PR!
222-
- [PR #688](https://github.com/sendgrid/sendgrid-csharp/pull/688) Fix mixup of Response.Body and Response.Header summarie. Big thanks to [Ryan David Sheasb](https://github.com/ryan27968) for the PR!
222+
- [PR #688](https://github.com/sendgrid/sendgrid-csharp/pull/688) Fix mixup of Response.Body and Response.Header summary. Big thanks to [Ryan David Sheasb](https://github.com/ryan27968) for the PR!
223223
- [PR #635](https://github.com/sendgrid/sendgrid-csharp/pull/635) Fixed "Variable assigned but never used" issue. Big thanks to [Unlocked](https://github.com/TheUnlocked) for the PR!
224224
- [PR #615](https://github.com/sendgrid/sendgrid-csharp/pull/615) Update USAGE.md - fix typo. Big thanks to [Anvesh Chaturvedi](https://github.com/anveshc05) for the PR!
225225
- [PR #613](https://github.com/sendgrid/sendgrid-csharp/pull/613) Update CONTRIBUTING.md - fix typo. Big thanks to [thepriefy](https://github.com/thepriefy) for the PR!

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ All third party contributors acknowledge that any contributions they provide wil
1313
- [Code Reviews](#code-reviews)
1414

1515
<a name="roadmap"></a>
16-
We use [GitHub Projects](https://github.com/sendgrid/sendgrid-csharp/projects) to help define current roadmaps, please feel free to grab an issue from our [GitHub Issues](https://github.com/sendgrid/sendgrid-csharp/issues). Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions and additional PRs are welcomed and encouraged.
16+
We use [GitHub Projects](https://github.com/sendgrid/sendgrid-csharp/projects) to help define current roadmaps, please feel free to grab an issue from our [GitHub Issues](https://github.com/sendgrid/sendgrid-csharp/issues). Please indicate that you have begun work on it to avoid collisions. Once a PR is made, community review, comments, suggestions, and additional PRs are welcomed and encouraged.
1717

1818
There are a few ways to contribute, which we'll enumerate below:
1919

@@ -36,8 +36,8 @@ A software bug is a demonstrable issue in the code base. In order for us to diag
3636

3737
Before you decide to create a new issue, please try the following:
3838

39-
1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
40-
2. Update to the latest version of this code and check if issue has already been fixed
39+
1. Check the GitHub issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
40+
2. Update to the latest version of this code and check if the issue has already been fixed
4141
3. Copy and fill in the Bug Report Template we have provided below
4242

4343
### Please use our Bug Report Template
@@ -132,7 +132,7 @@ Generally, we follow the style guidelines as suggested by the official language.
132132
git pull upstream <dev-branch>
133133
```
134134

135-
3. Create a new topic branch off the `development` branch to
135+
3. Create a new topic branch (off the main project development branch) to
136136
contain your feature, change, or fix:
137137

138138
```bash
@@ -167,4 +167,4 @@ Generally, we follow the style guidelines as suggested by the official language.
167167
<a name="code-reviews"></a>
168168
## Code Reviews
169169

170-
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, Github has some great information on how to review a Pull Request.
170+
If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how GitHub has some great information on how to review a Pull Request.
Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**The Twilio SendGrid C# .NET library provide an easy way to send emails. This example application shows how to integrate with an ASP.NET application.**
1+
**The Twilio SendGrid C# .NET library provides an easy way to send emails. This example application shows how to integrate with an ASP.NET application.**
22

33
# Installation
44

@@ -7,20 +7,20 @@
77
- .NET version 4.5.2 and higher
88
- Visual Studio 2015
99

10-
## Setup Environment Variables
10+
## Setup Environment Variables
1111

1212
Update the "SendGridApiKey" appSettings variable within the web.config file.
1313

1414
## Steps
1515

1616
1. Open SendGrid.ASPSamples.sln
17-
2. Switch to one of the example project (right click on a project -> "Set as StartUp project")
18-
2. Build and run the project
17+
2. Switch to one of the example project (right-click on a project -> "Set as StartUp project")
18+
3. Build and run the project
1919

20-
You may need to download the latest Nuget executable and run `nuget.exe restore`
20+
You may need to download the latest Nuget executable and run `nuget.exe restore`
2121

22-
3. When you run the project, a web form will launch in your browser that will send an email.
22+
4. When you run the project, a web form will launch in your browser that will send an email.
2323

2424
## Happy coding
2525

26-
Big thanks to [paritosh baghel](https://github.com/paritoshmmmec) for contributing this example code!
26+
Big thanks to [paritosh baghel](https://github.com/paritoshmmmec) for contributing this example code!

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,14 @@ Setup Environment Variables using the UI:
7373
1. Press Win+R and run SystemPropertiesAdvanced
7474
2. Click on Environment Variables
7575
3. Click New in user variables section
76-
4. Type SENDGRID_API_KEY in the name. (Make sure this name matches the name of key in your code)
76+
4. Type SENDGRID_API_KEY in the name. (Make sure this name matches the name of the key in your code)
7777
5. Type actual API Key in the value
7878
6. Restart the IDE and you're done!
7979

8080
Setup Environment Variables using CMD:
8181

8282
1. Run CMD as administrator
83-
2. setx SENDGRID_API_KEY "YOUR_API_KEY"
83+
2. set SENDGRID_API_KEY "YOUR_API_KEY"
8484

8585
Here are a few examples to get and set API Keys programmatically:
8686

TROUBLESHOOTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
If you have an issue logging into your Twilio SendGrid account, please read this [document](https://sendgrid.com/docs/ui/account-and-settings/troubleshooting-login/). For any questions regarding login issues, please contact our [support team](https://support.sendgrid.com).
1+
If you have an issue logging into your Twilio SendGrid account, please read this [document](https://sendgrid.com/docs/ui/account-and-settings/troubleshooting-login/). For any questions regarding login issues, please contact our [support team](https://support.sendgrid.com).
22

33
If you have a non-library Twilio SendGrid issue, please contact our [support team](https://support.sendgrid.com).
44

@@ -48,7 +48,7 @@ becomes
4848

4949
`string apiKey = "SENDGRID_API_KEY";`
5050

51-
In the first case SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
51+
In the first case, SENDGRID_API_KEY is in reference to the name of the environment variable, while the second case references the actual Twilio SendGrid API Key.
5252

5353
<a name="error"></a>
5454
## Error Messages
@@ -171,7 +171,7 @@ In most cases we recommend you download the latest version of the library, but i
171171
<a name="versioning"></a>
172172
## Versioning Convention
173173

174-
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with to your code and never auto-update to the latest version. Especially when there is a MAJOR point release, since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases) section.
174+
We follow the MAJOR.MINOR.PATCH versioning scheme as described by [SemVer.org](http://semver.org). Therefore, we recommend that you always pin (or vendor) the particular version you are working with your code and never auto-update to the latest version. Especially when there is a MAJOR point release since that is guaranteed to be a breaking change. Changes are documented in the [CHANGELOG](CHANGELOG.md) and [releases](https://github.com/sendgrid/sendgrid-csharp/releases) section.
175175

176176
<a name="request-body"></a>
177177
## Viewing the Request Body
@@ -187,7 +187,7 @@ Console.WriteLine(msg.Serialize());
187187
<a name="ui-requests"></a>
188188
## UI Requests are Failing / Deadlocks
189189

190-
If your UI based requests are failing, it may be due to a little known issue where the UI only has a single thread. The answer here is to use `ConfigureAwait(false)` on the end of your request call, so that the thread does not reset back to request context and stays in capture context. Normally, async the request thread would "let go" of the capture context and reset to request context. With the UI, there is only a single thread, so you have to force the thread to switch to capture context, using `ConfigureAwait(false)`. For more information, please see a better summary that is linked to a longer article [in StackOverflow](https://stackoverflow.com/a/13494570).
190+
If your UI based requests are failing, it may be due to a little known issue where the UI only has a single thread. The answer here is to use `ConfigureAwait(false)` on the end of your request call so that the thread does not reset back to request context and stays in capture context. Normally, async the request thread would "let go" of the capture context and reset to request context. With the UI, there is only a single thread, so you have to force the thread to switch to capture context, using `ConfigureAwait(false)`. For more information, please see a better summary that is linked to a longer article [in StackOverflow](https://stackoverflow.com/a/13494570).
191191

192192
In our example code, you would change:
193193

@@ -203,4 +203,4 @@ var response = await client.SendEmailAsync(msg).ConfigureAwait(false);
203203

204204
If you are running a newer versions of .NET you can turn on a couple different Roslyn based analyzers that will trigger build errors if you're not calling `.ConfigureAwait(false)` on your async methods.
205205

206-
`Roslynator.Analyzers` can be installed through NuGet or as a VS plugin, but if you use the plugin then the analyzers won't run on build servers and trigger build errors like the NuGet package would. (thanks to [xt0rted](https://github.com/xt0rted) for this tip!)
206+
`Roslynator.Analyzers` can be installed through NuGet or as a VS plugin, but if you use the plugin then the analyzers won't run on build servers and trigger build errors as the NuGet package would. (thanks to [xt0rted](https://github.com/xt0rted) for this tip!)

0 commit comments

Comments
 (0)