Skip to content

Improved doc description of the ExportDiff property #1465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2020
+3 −3
Merged

Improved doc description of the ExportDiff property #1465

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/articles/features/disassembler.md
View file
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ The configuration options available from code level are:
* `exportGithubMarkdown`: Exports to GitHub markdown. True by default.
* `exportHtml`: Exports to HTML with clickable links. False by default.
* `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).
* `exportDiff`: Exports a diff. False by default.
* `exportDiff`: Exports a diff of the assembly code to the Github markdown format. False by default.

### Requirements

2 changes: 1 addition & 1 deletion src/BenchmarkDotNet/Attributes/DisassemblyDiagnoserAttribute.cs
View file
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ public class DisassemblyDiagnoserAttribute : Attribute, IConfigSource
/// <param name="exportGithubMarkdown">Exports to GitHub markdown. True by default.</param>
/// <param name="exportHtml">Exports to HTML with clickable links. False by default.</param>
/// <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>
/// <param name="exportDiff">Exports a diff. False by default.</param>
/// <param name="exportDiff">Exports a diff of the assembly code to the Github markdown format. False by default.</param>
public DisassemblyDiagnoserAttribute(
int maxDepth = 1,
bool printSource = false,
2 changes: 1 addition & 1 deletion src/BenchmarkDotNet/Disassemblers/DisassemblyDiagnoserConfig.cs
View file
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ public class DisassemblyDiagnoserConfig
/// <param name="exportGithubMarkdown">Exports to GitHub markdown. True by default.</param>
/// <param name="exportHtml">Exports to HTML with clickable links. False by default.</param>
/// <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>
/// <param name="exportDiff">Exports a diff. False by default.</param>
/// <param name="exportDiff">Exports a diff of the assembly code to the Github markdown format. False by default.</param>
[PublicAPI]
public DisassemblyDiagnoserConfig(
int maxDepth = 1,