NUnit documentation improvements #802
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| /// The [NUnit](http://www.nunit.org/) Console Parameters type. | ||
| /// FAKE will use [NUnitDefaults](fake-nunitcommon.html) for values not provided. | ||
| /// | ||
| /// For reference, see: [NUnit-Console Command Line Options](http://www.nunit.org/index.php?p=consoleCommandLine&r=2.6.4) | ||
| type NUnitParams = |
There was a problem hiding this comment.
In my PR, #800, making changes and documentation improvements to the xUnit tasks, I put the default values as documentation for the defaults value. Having it here seems wrong as a record doesn't actually have any defaults. So, my recommendation would be to move the documentation for the defaults to NUnitDefaults.
There was a problem hiding this comment.
Yes, it looks wrong. I will change it to the same style as your comments to xUnit then.
…to NUnitDefault docs
|
very very cool. Thx |
forki
added a commit
that referenced
this pull request
May 20, 2015
…mprovements NUnit documentation improvements
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains small improvements to documentation related to NUnit.
NUnitSequentialtask on getting started page. Both links on getting started were pointing toNUnitParalleldocumentation.NUnitParamsapidoc onNUnitSequentialandNUnitParalleldocumentation. I am not sure if this is the correct way to add a link to another file in the API docs.NUnitParamsinNUnitDefaultsdocs.NUnitParamsrecord fields with text from NUnit documentation.