Skip to content

fixup docs#392

Merged
billwert merged 3 commits into
dotnet:masterfrom
billwert:fix-docs
Mar 19, 2019
Merged

fixup docs#392
billwert merged 3 commits into
dotnet:masterfrom
billwert:fix-docs

Conversation

@billwert

Copy link
Copy Markdown
Contributor

In #391 I changed how dotnet run needs to be invoked but didn't clean
up the docs.

In dotnet#391 I changed how `dotnet run` needs to be invoked but didn't clean
up the docs.
@billwert
billwert requested a review from adamsitnik March 19, 2019 19:03

@adamsitnik adamsitnik left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @billwert !

Comment thread docs/benchmarking-workflow-corefx.md
Comment thread docs/benchmarking-workflow-corefx.md Outdated
Comment thread docs/benchmarkdotnet.md Outdated

You can filter the benchmarks using `--filter $globPattern` console line argument. The filter is **case insensitive**.

<!-- markdownlint-disable MD029 -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the warning about non-indented bullet points? Can they be fixed instead?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, it's about having a bunch of stuff between the numbers like we do. It's not really fixable to get the effect we want, which is a series of steps with lots of description in them. That's why I chose to disable this warning; it's not really a problem in this context.

Comment thread docs/benchmarkdotnet.md Outdated
dotnet run -c Release -f netcoreapp2.1 --filter BenchmarksGame* --join
```

<!-- markdownlint-enable MD029 -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

see above.

@jorive

jorive commented Mar 19, 2019

Copy link
Copy Markdown

Please do not add markdown warnings tags. Those warnings can be fixed.

@billwert

Copy link
Copy Markdown
Contributor Author

@jorive the warnings didn't seem trivially reasonable to fix in the context (specifically the list one. The space one could have been fixed, which I have done.)

@jorive

jorive commented Mar 19, 2019

Copy link
Copy Markdown

If the markdown renders properly, could you please ignore and remove the tags?

This isn't really a set of steps, but a group of examples. Numbers
aren't necessary.

this removes the need to disable linter warnings.
@billwert

Copy link
Copy Markdown
Contributor Author

@jorive swapped to bullets.

@billwert
billwert merged commit 1eeb411 into dotnet:master Mar 19, 2019
@billwert
billwert deleted the fix-docs branch March 19, 2019 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants