Skip to content

Commit 35f50fb

Browse files
Improved doc description of the ExportDiff property (#1465)
1 parent bd1c934 commit 35f50fb

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/articles/features/disassembler.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The configuration options available from code level are:
1515
* `exportGithubMarkdown`: Exports to GitHub markdown. True by default.
1616
* `exportHtml`: Exports to HTML with clickable links. False by default.
1717
* `exportCombinedDisassemblyReport`: Exports all benchmarks to a single HTML report. Makes it easy to compare different runtimes or methods (each becomes a column in HTML table).
18-
* `exportDiff`: Exports a diff. False by default.
18+
* `exportDiff`: Exports a diff of the assembly code to the Github markdown format. False by default.
1919

2020
### Requirements
2121

src/BenchmarkDotNet/Attributes/DisassemblyDiagnoserAttribute.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public class DisassemblyDiagnoserAttribute : Attribute, IConfigSource
1313
/// <param name="exportGithubMarkdown">Exports to GitHub markdown. True by default.</param>
1414
/// <param name="exportHtml">Exports to HTML with clickable links. False by default.</param>
1515
/// <param name="exportCombinedDisassemblyReport">Exports all benchmarks to a single HTML report. Makes it easy to compare different runtimes or methods (each becomes a column in HTML table).</param>
16-
/// <param name="exportDiff">Exports a diff. False by default.</param>
16+
/// <param name="exportDiff">Exports a diff of the assembly code to the Github markdown format. False by default.</param>
1717
public DisassemblyDiagnoserAttribute(
1818
int maxDepth = 1,
1919
bool printSource = false,

src/BenchmarkDotNet/Disassemblers/DisassemblyDiagnoserConfig.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class DisassemblyDiagnoserConfig
1414
/// <param name="exportGithubMarkdown">Exports to GitHub markdown. True by default.</param>
1515
/// <param name="exportHtml">Exports to HTML with clickable links. False by default.</param>
1616
/// <param name="exportCombinedDisassemblyReport">Exports all benchmarks to a single HTML report. Makes it easy to compare different runtimes or methods (each becomes a column in HTML table).</param>
17-
/// <param name="exportDiff">Exports a diff. False by default.</param>
17+
/// <param name="exportDiff">Exports a diff of the assembly code to the Github markdown format. False by default.</param>
1818
[PublicAPI]
1919
public DisassemblyDiagnoserConfig(
2020
int maxDepth = 1,

0 commit comments

Comments
 (0)