Formatting on console-teleprompter #1210

BillWagner · 2016-11-06T19:50:25Z

This addresses the final feedback in PR #1073. I’ll close that PR as this replaces it.

Important: Please to a merge commit instead of a squash commit when we merge this. We want to preserve the original PR commits, including the committer

Update console-teleprompter.md Update console-teleprompter.md Update console-teleprompter.md

saldana · 2016-11-06T20:03:19Z

Open Publishing Build Service: The pull request content has been published and here are some changed files links of this time:

Docset 1 - core-docs
https://review.docs.microsoft.com/en-us/dotnet/articles/csharp/tutorials/console-teleprompter?branch=pr-en-us-1210

Status: Succeeded.
Open Publishing Report.

svick · 2016-11-06T20:25:01Z

docs/csharp/tutorials/console-teleprompter.md

@@ -239,8 +238,8 @@ steps in it and by the end, you’ll have all the updates that you need.
 The first step is to create an asynchronous `Task` returning method that
 represents the code you’ve created so far to read and display the file.

-Add this method to your Program class: (It’s taken from the body of your
-Main method:
+Add this method to your Program class (It’s taken from the body of your


I think Program should be formatted as code

"It's" should be lowercase, since it is part of the sentence now

BillWagner · 2016-11-07T17:26:59Z

@svick I made the suggested updates.
I also squashed to make a clean history to merge.

saldana · 2016-11-07T17:36:59Z

✅ Validation status: passed

File	Status	Preview URL	Details
docs/csharp/tutorials/console-teleprompter.md	✅Succeeded	View	Details

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

rpetrusha · 2016-11-07T23:29:44Z

docs/csharp/tutorials/console-teleprompter.md

@@ -111,14 +112,14 @@ using System.IO;
 ```

 The `IEnumerable<T>` interface is defined in the 
-`System.Collections.Generic` namespace. The File class is defined in the
-`System.IO namespace`.
+`System.Collections.Generic` namespace. The `File` class is defined in the


It might be better to change File to @System.IO.File so that it's resolved as a link.

rpetrusha · 2016-11-07T23:33:49Z

docs/csharp/tutorials/console-teleprompter.md

 implement the `IDisposable` interface. The `IDisposable` interface
-defines a single method, `Dispose()`, that should be called when the
+defines a single method, `Dispose`, that should be called when the


Here again, it might be better to change these from IDisposable to @System.IDisposable, and from Dispose to @System.IDisposable.Dispose so that they resolve as links.

rpetrusha · 2016-11-07T23:35:50Z

docs/csharp/tutorials/console-teleprompter.md

 *implicitly typed local variable*. That means the type of the variable is
 determined by the compile time type of the object assigned to the
-variable. Here, that is the return value from `File.OpenText()`, which is
+variable. Here, that is the return value from `File.OpenText`, which is
 a `StreamReader` object.


Here again, FIle.OpenText could be File.OpenText so it resolves as a link. Similarly, @System.IO.StreamReader instead of StreamReader.

rpetrusha · 2016-11-07T23:42:37Z

docs/csharp/tutorials/console-teleprompter.md

@@ -239,8 +238,8 @@ steps in it and by the end, you’ll have all the updates that you need.
 The first step is to create an asynchronous `Task` returning method that


Task-returning. Task could be a link -- @System.Threading.Tasks.Task.

rpetrusha · 2016-11-07T23:43:23Z

docs/csharp/tutorials/console-teleprompter.md

@@ -258,25 +257,25 @@ private static async Task ShowTeleprompter()
 ```

 You’ll notice two changes. First, in the body of the method, instead of
-calling `Wait()` to synchronously wait for a task to finish, this version
+calling `Wait` to synchronously wait for a task to finish, this version


Maybe resolve this as a link -- @System.Threading.Tasks.Task.Wait.
@BillWagner

rpetrusha · 2016-11-07T23:45:37Z

docs/csharp/tutorials/console-teleprompter.md

@@ -310,12 +309,12 @@ private static async Task GetInput()

 This creates a lambda expression to represent an `Action` that reads a key


Here the link would be helpful -- @System.Action. Also, perhaps "Action delegate"?

rpetrusha · 2016-11-07T23:46:52Z

docs/csharp/tutorials/console-teleprompter.md

@@ -310,12 +309,12 @@ private static async Task GetInput()

 This creates a lambda expression to represent an `Action` that reads a key
 from the Console and modifies a local variable representing the delay when
-the user presses the ‘<’ or ‘>’ keys. This method uses `Console.ReadKey()`
+the user presses the ‘<’ or ‘>’ keys. This method uses `Console.ReadKey`


Replace with a link to @System.Console.ReadKey?

rpetrusha · 2016-11-07T23:51:22Z

docs/csharp/tutorials/console-teleprompter.md

@@ -376,11 +375,11 @@ private static async Task RunTeleprompter()
 }
 ```

-The one new method here is the `Task.WhenAny()` call. That creates a Task
+The one new method here is the `Task.WhenAny` call. That creates a `Task`


Replace with a link to Task.WhenAny?

BillWagner · 2016-11-08T00:13:49Z

Responded to @rpetrusha feedback and re-squashed.

BillWagner · 2016-11-08T00:30:09Z

@rpetrusha I made all your suggested changes. Do you want to review again, or is it ready to ship?

saldana · 2016-11-08T00:34:00Z

✅ Validation status: passed

File	Status	Preview URL	Details
docs/csharp/tutorials/console-teleprompter.md	✅Succeeded	View	Details

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

rpetrusha · 2016-11-08T16:37:27Z

@BillWagner I'll review it again quickly.

rpetrusha · 2016-11-08T16:45:30Z

docs/csharp/tutorials/console-teleprompter.md

-implement the `IDisposable` interface. The `IDisposable` interface
-defines a single method, `Dispose()`, that should be called when the
+initialized in the `using` statement (`reader`, in this example) must
+implement the `IDisposable` interface. The @System.IDisposables interface


typo: @System.IDisposable

rpetrusha · 2016-11-08T16:46:42Z

docs/csharp/tutorials/console-teleprompter.md

 *implicitly typed local variable*. That means the type of the variable is
 determined by the compile time type of the object assigned to the
-variable. Here, that is the return value from `File.OpenText()`, which is
-a `StreamReader` object.
+variable. Here, that is the return value from @File.OpenTexts, which is


should be @System.IO.File.OpenText

rpetrusha · 2016-11-08T16:47:02Z

docs/csharp/tutorials/console-teleprompter.md

-variable. Here, that is the return value from `File.OpenText()`, which is
-a `StreamReader` object.
+variable. Here, that is the return value from @File.OpenTexts, which is
+a @System.IO.sStreamReader object.


typo: @System.IO.StreamReader

rpetrusha · 2016-11-08T16:52:50Z

docs/csharp/tutorials/console-teleprompter.md

@@ -376,11 +375,11 @@ private static async Task RunTeleprompter()
 }
 ```

-The one new method here is the `Task.WhenAny()` call. That creates a Task
+The one new method here is the @System.Threading.Tasks.Task.WhenAny call. That creates a `Task`


This doesn't resolve. Should be @System.Threading.Tasks.Task.WhenAny(System.Threading.Tasks.Task[]).

rpetrusha · 2016-11-08T16:54:30Z

@BillWagner A few links didn't resolve. For the last one, you could also use Task.WhenAny for simplicity, though a link to method would be nice. Once those issues are addressed, LGTM.

@rpetrusha

Also, updated the freshness date, and add the ms.author metadata tag. Respond to updated feedback Respond to @rpetrusha feedback. Fix a few broken links

saldana · 2016-11-08T18:04:45Z

✅ Validation status: passed

File	Status	Preview URL	Details
docs/csharp/tutorials/console-teleprompter.md	✅Succeeded	View	Details

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

BillWagner · 2016-11-08T18:14:33Z

rebasing and merging.

Thanks @rpetrusha

Fix formatting console-teleprompter.md

ebf38d1

Update console-teleprompter.md Update console-teleprompter.md Update console-teleprompter.md

dnfclas added the cla-already-signed label Nov 6, 2016

BillWagner mentioned this pull request Nov 6, 2016

Fix formatting console-teleprompter.md #1073

Closed

svick reviewed Nov 6, 2016

View reviewed changes

rpetrusha reviewed Nov 7, 2016

View reviewed changes

rpetrusha reviewed Nov 8, 2016

View reviewed changes

respond to remaining feedback on PR #1073

c801ab6

Also, updated the freshness date, and add the ms.author metadata tag. Respond to updated feedback Respond to @rpetrusha feedback. Fix a few broken links

BillWagner closed this Nov 8, 2016

BillWagner reopened this Nov 8, 2016

BillWagner merged commit 325c8a9 into dotnet:master Nov 8, 2016

BillWagner deleted the formatting-console-teleprompter-1073 branch November 8, 2016 18:28

		@@ -239,8 +238,8 @@ steps in it and by the end, you’ll have all the updates that you need.
		The first step is to create an asynchronous `Task` returning method that

		@@ -310,12 +309,12 @@ private static async Task GetInput()

		This creates a lambda expression to represent an `Action` that reads a key

Formatting on console-teleprompter #1210

Formatting on console-teleprompter #1210

Uh oh!

Conversation

BillWagner commented Nov 6, 2016

Uh oh!

saldana commented Nov 6, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BillWagner commented Nov 7, 2016

Uh oh!

saldana commented Nov 7, 2016

✅ Validation status: passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BillWagner commented Nov 8, 2016

Uh oh!

BillWagner commented Nov 8, 2016

Uh oh!

saldana commented Nov 8, 2016

✅ Validation status: passed

Uh oh!

rpetrusha commented Nov 8, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rpetrusha commented Nov 8, 2016

Uh oh!

saldana commented Nov 8, 2016

✅ Validation status: passed

Uh oh!

BillWagner commented Nov 8, 2016

Uh oh!

Uh oh!