nunit / nunit/docs

Language ambiguity in Getting Started

Open
#665 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In Getting Started > Installation > Using NuGet NUnitLite Package, there is a paragraph saying:

As a result of your installation, a file named "Program.cs" will have been copied into each of your test projects. NUnitLite test projects are console applications and this file contains the Main() program for your tests. If you already have a Main() in some other class, you may delete the file. This file also contains comments describing how the main should call the NUnitLite runner.

The italicized part is a bit ambiguous. Which file containing Main() should be deleted? Which Main() should call the NUnitLite runner? The developer's or the autogenerated one? It might seem trivial, considering you wouldn't want the developer to erase their Main(), but it's still confusing what the docs are trying to say in this paragraph.

Please consider making the language a little clear in this paragraph. Even a simple change such as "... you may delete the this autogenerated file" will clarify the section a lot.

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

Open docs/articles/nunit/getting-started/installation.md and read the “Using NuGet NUnitLite Package” section, focusing on the paragraph about Program.cs and Main(). Clarify which autogenerated file may be deleted and which Main() should call the NUnitLite runner. Done when the paragraph unambiguously distinguishes the generated file from any developer-written entry point.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.