nunit / nunit/docs

TestContext documentation seems either outdated or just missing stuff

Open
#531 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

pri:p1
Dominant language
Dockerfile
Stars
600
Forks
158
Avg merge
16h 8m
Merged PRs (30d)
21

Description

  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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the TestContext documentation page linked in the issue and compare it with src/NUnitFramework/framework/TestContext.cs. Correct the TestContext.Parameters naming and document the additional properties identified from the source, including TestAdapter and ResultAdapter.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.