docs: fix typos and improve accuracy in README.md and contributing guide#281
Open
cluster2600 wants to merge 1 commit intoNVIDIA:masterfrom
Open
Conversation
README.md: - 'the image provide' → 'the image provides' (subject-verb agreement) - 'you can use the run build.sh' → 'you can run build.sh' (remove extra word) - 'A simple debian build' → 'A simple Debian build' (proper noun) - 'The rpm will be placed in ...\.deb' → 'The .deb package will be placed in' (the example command was --deb, not --rpm; the description was wrong) - Hardcoded version '2.1.4' replaced with '<version>' placeholder to avoid misleading readers as the version changes across releases - 'can been seen' → 'can be seen' (grammar fix) docs/contributing.md: - 'NVIDIAGPUs' → 'NVIDIA GPUs' (missing space between brand and noun) - 'dcgm_best_practices.md' → '[coding_best_practices.md]' with correct filename and Markdown hyperlink (the actual file is coding_best_practices.md)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Fix several typos, a factual error, a broken internal link, and minor grammar issues in
README.mdanddocs/contributing.md.README.md
the image provide custom buildsthe image provides custom buildsyou can use the runbuild.sh``you can runbuild.sh``A simple debian buildA simple Debian buildThe rpm will be placed in …\.debThe .deb package will be placed in--deb, not--rpm)2.1.4in example path<version>placeholdercan been seencan be seendocs/contributing.md
NVIDIAGPUsNVIDIA GPUsdcgm_best_practices.md(plain text, wrong filename)[coding_best_practices.md](coding_best_practices.md)(link, correct filename)Why
The rpm will be placed in …\.debsentence is the most impactful: a first-time contributor building with--debgets a path description that says "rpm" and an outdated version number. This is confusing and undermines confidence in the build guide.NVIDIAGPUs(no space) reads as a single word in the Contributing introduction; browsers and screen readers handle it poorly.dcgm_best_practices.mddoes not exist in the repo; the actual file iscoding_best_practices.md. A reader following the link (once it becomes a hyperlink) or searching for the file would not find it.How
All changes are textual — no code, no logic, no tests affected.
Testing
grep -n 'rpm will be placed\|can been\|NVIDIAGPUs\|dcgm_best_practices' README.md docs/contributing.mdreturns no results after the patchChecklist