nunit / nunit/docs

Attributes that don't exist on .NET Standard builds are not so noted in docs

Open
#236 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Following a comment on issue #235, it seems as if we should have a section in the docs for each attribute (and possibly other stuff as well) that indicates which framework builds support the particular item. Priority can be given to those that do not exist in our .NET Standard builds, like TimeoutAttribute and PlatformAttribute.

As a possibly broader issue in the framework repo, we may want to consider whether more attributes should be supported in compilation but give a warning when used in the wrong platform. We already support a few parallelization-related attributes for compilation only, but the only warning is (I think) in the docs.

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

Review issue #235 and the existing documentation for TimeoutAttribute and PlatformAttribute, then identify how framework-build support is currently described. Done means the relevant attributes, especially those absent from .NET Standard builds, have clear build-support notes in the docs; the broader compilation-warning question is separate and unresolved.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.