docs icon indicating copy to clipboard operation
docs copied to clipboard

TestContext documentation seems either outdated or just missing stuff

Open OsirisTerje opened this issue 4 years ago • 3 comments

  1. See https://docs.nunit.org/articles/nunit/writing-tests/TestContext.html#testparameters The correct property name is is TestContext.Parameters, the TestParameters is the type.
  2. There are more properties that are not documented, see https://github.com/nunit/nunit/blob/master/src/NUnitFramework/framework/TestContext.cs , e.g. TestAdapter, ResultAdapter and more.

OsirisTerje avatar Dec 01 '20 21:12 OsirisTerje

See https://docs.nunit.org/articles/nunit/writing-tests/TestContext.html#testparameters The correct property name is is TestContext.Parameters, the TestParameters is the type.

I just came across this too, I had no idea how to get around it, but luckily I found a blog post

stevenbrix avatar Apr 08 '21 17:04 stevenbrix

I this TestContext.Test.Properties should also be updated. It is currently described as an IPropertyBag but this was changed in 3.10 as part of https://github.com/nunit/nunit/issues/1578. A question was just asked in the framework repo (https://github.com/nunit/nunit/issues/4059) about it

stevenaw avatar Mar 11 '22 01:03 stevenaw

Just putting it out there that this is likely part of a larger issue -- the docfx docs are separate from the codebase and are manually maintained.

Docfx allows (and is indeed designed for) generating docs from the codebase. Perhaps it's time to look at what our options might be there.

SeanKilleen avatar Jan 06 '23 16:01 SeanKilleen