nunit / nunit/docs

SetUpFixture undocumented in the XML documentation

Open
#179 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

The current documentation for a test-suite element in the xml file states:

type The type of suite represented by this element. Currently supported types are Assembly, TestSuite, TestFixture,

However, "SetUpFixture" apparently is also a valid type. At least, it is appearing in the xml file:

     <test-suite type="SetUpFixture" id="1157" name="Rest" fullname="Twilio.Tests.Rest.TestSetup" classname="Twilio.Tests.Rest.TestSetup" runstate="Runnable" testcasecount="759">

This being undocumented broke my GUI and my result viewer :(

Is it a documentation issue, or is it a framework issue?

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 by locating the documentation for the XML test-suite element and its supported type list. Confirm that SetUpFixture is a valid emitted type, then document it alongside Assembly, TestSuite, and TestFixture; done when the XML documentation accurately lists it.

Written by the indexing model from the issue text.

Assessment

Tech stack
xml
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.