Language ambiguity in Getting Started
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- csharp
- Domain
- documentation
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.
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.
- Dominant language
- Dockerfile
- Stars
- 600
- Forks
- 158
- Avg merge
- 16h 8m
- Merged PRs (30d)
- 21
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nunit/docs
-
area:framework
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
area:framework
-
area:framework
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
area:framework
Difficulty 4/5 3-5 days Newbie friendliness 40/100
Similar issues
-
Area: Excel support
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
orbeon/orbeon-forms#7893 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
docToolchain/docToolchain#1705 ·
-
kb-infra-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
OCHA-DAP/ds-knowledge-base#653 · 1 comment ·
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
namespace operations
Difficulty 1/5 Under an hour Newbie friendliness 90/100
EclipseFdn/open-vsx.org#13419 ·