docs icon indicating copy to clipboard operation
docs copied to clipboard

Language ambiguity in Getting Started

Open dcdeepesh opened this issue 2 years ago • 1 comments

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.

dcdeepesh avatar Jul 27 '22 07:07 dcdeepesh

The text should probably be rewritten as we no longer supply a Program.cs file (and it haven't been working for years). I overlooked this page when I did the cleanup in #604. Looking at the entire page it seems like it could use an update.

mikkelbu avatar Jul 27 '22 14:07 mikkelbu