Skip to content

Commit dd1d5fd

Browse files
update test README.md
1 parent ddf5295 commit dd1d5fd

File tree

1 file changed

+33
-4
lines changed

1 file changed

+33
-4
lines changed

CommandDotNet.Tests/README.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,47 @@ The second pattern is run an instance of the AppRunner using `AppRunner.RunInMem
1515
{
1616
public int ExitCode { get; }
1717

18-
// the console output
18+
/// <summary>
19+
/// The combination of <see cref="Console.Error"/> and <see cref="Console.Out"/>
20+
/// in the order they were written from the app.<br/>
21+
/// This is how the output would appear in the shell.
22+
/// </summary>
23+
public string ConsoleOutAndError { get; }
24+
25+
/// <summary>The error output only</summary>
1926
public string ConsoleOut { get; }
27+
28+
/// <summary>The standard output only</summary>
2029
public string ConsoleError { get; }
21-
public string ConsoleOutAndError { get; }
2230

2331
// described in the scenario readme.md from above
32+
/// <summary>
33+
/// <see cref="TestOutputs"/> captured in the command class.
34+
/// The command class must have a public <see cref="TestOutputs"/> property for this to work.<br/>
35+
/// This is a convenience for testing how inputs are mapped into the command method parameters.<br/>
36+
/// Useful for testing middleware components, not the business logic of your commands.
37+
/// </summary>
2438
public TestOutputs TestOutputs { get; }
2539

26-
// helpers that normalize the help output which
27-
// can contain extra whitespace at the end of lines.
40+
/// <summary>
41+
/// Help generation leaves extra trailing spaces that are hard to account for in test verification.
42+
/// This method removes trailing white space from each line and standardizes Environment.NewLine
43+
/// for all line endings
44+
/// </summary>
2845
public void OutputShouldBe(string expected){...}
46+
47+
/// <summary>
48+
/// Help generation leaves extra trailing spaces that are hard to account for in test verification.
49+
/// This method removes trailing white space from each line and standardizes Environment.NewLine
50+
/// for all line endings
51+
/// </summary>
2952
public bool OutputContains(string expected){...}
53+
54+
/// <summary>
55+
/// Help generation leaves extra trailing spaces that are hard to account for in test verification.
56+
/// This method removes trailing white space from each line and standardizes Environment.NewLine
57+
/// for all line endings
58+
/// </summary>
3059
public bool OutputNotContains(string expected){...}
3160
}
3261
```

0 commit comments

Comments
 (0)