← Back to team overview

nunit-core team mailing list archive

[Bug 992799] [NEW] SetUpFixture and SetUp doc inconsistency

 

Public bug reported:

The SetUpFixtureAttribute  web docs
(http://www.nunit.org/index.php?p=setupFixture&r=2.6) says "This is the
attribute that marks a class that contains the one-time setup or
teardown methods for all the test fixtures under a given namespace."
However, the XML docs (http://bazaar.launchpad.net/~nunit-
core/nunitv2/trunk/view/head:/src/NUnitFramework/framework/Attributes/SetUpFixtureAttribute.cs#L11)
just say "SetUpFixtureAttribute is used to identify a SetUpFixture"
which is vague.

More confusingly, the SetUpAttribute XML docs
(http://bazaar.launchpad.net/~nunit-
core/nunitv2/trunk/view/head:/src/NUnitFramework/framework/Attributes/SetUpAttribute.cs)
say, "Attribute used to mark a class that contains one-time SetUp
and/or TearDown methods that apply to all the tests in a namespace or an
assembly."  However, the web docs say "This attribute is used inside a
TestFixture to provide a common set of functions that are performed just
before each test method is called." (which I think is correct).

It looks like the SetUpAttribute XML docs have text belonging to
SetUpFixtureAttribute.

** Affects: nunitv2
     Importance: Undecided
         Status: New

-- 
You received this bug notification because you are a member of NUnit
Developers, which is subscribed to NUnit V2.
https://bugs.launchpad.net/bugs/992799

Title:
  SetUpFixture and SetUp doc inconsistency

Status in NUnit V2 Test Framework:
  New

Bug description:
  The SetUpFixtureAttribute  web docs
  (http://www.nunit.org/index.php?p=setupFixture&r=2.6) says "This is
  the attribute that marks a class that contains the one-time setup or
  teardown methods for all the test fixtures under a given namespace."
  However, the XML docs (http://bazaar.launchpad.net/~nunit-
  core/nunitv2/trunk/view/head:/src/NUnitFramework/framework/Attributes/SetUpFixtureAttribute.cs#L11)
  just say "SetUpFixtureAttribute is used to identify a SetUpFixture"
  which is vague.

  More confusingly, the SetUpAttribute XML docs
  (http://bazaar.launchpad.net/~nunit-
  core/nunitv2/trunk/view/head:/src/NUnitFramework/framework/Attributes/SetUpAttribute.cs)
  say, "Attribute used to mark a class that contains one-time SetUp
  and/or TearDown methods that apply to all the tests in a namespace or
  an assembly."  However, the web docs say "This attribute is used
  inside a TestFixture to provide a common set of functions that are
  performed just before each test method is called." (which I think is
  correct).

  It looks like the SetUpAttribute XML docs have text belonging to
  SetUpFixtureAttribute.

To manage notifications about this bug go to:
https://bugs.launchpad.net/nunitv2/+bug/992799/+subscriptions


Follow ups

References