Skip to content

Use professional wording in env report docs#409

Open
liujane-dev wants to merge 2 commits into
NVIDIA:developfrom
liujane-dev:liujane/fixguardword
Open

Use professional wording in env report docs#409
liujane-dev wants to merge 2 commits into
NVIDIA:developfrom
liujane-dev:liujane/fixguardword

Conversation

@liujane-dev

@liujane-dev liujane-dev commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Before submitting

  • I agree to license this contribution under the terms of LICENSE.txt.
  • I ran pre-commit run and committed any formatting changes.

Affected area

Summary

Why

Related issues

API and compatibility impact

Testing

Summary by CodeRabbit

  • Documentation
    • Updated the bug report template’s environment guidance to reflect wording for when import cudnn fails.
    • Refined the README “Environment report” troubleshooting steps, including explicit instructions to download and run the environment collection script standalone with any Python.
    • Rephrased related in-script documentation/comments for clarity without changing behavior or output.

@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 94e7a2fa-6fd6-4442-a612-82aaea49cbd4

📥 Commits

Reviewing files that changed from the base of the PR and between 6238312 and 5963602.

📒 Files selected for processing (1)
  • python/cudnn/collect_env.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • python/cudnn/collect_env.py

📝 Walkthrough

Walkthrough

Updated bug-report and README instructions for failed import cudnn cases, refreshed collect_env.py documentation and a related comment, and left environment collection logic unchanged.

Changes

Environment reporting guidance

Layer / File(s) Summary
Standalone environment collection guidance
.github/ISSUE_TEMPLATE/bug_report.yml, README.md, python/cudnn/collect_env.py
Clarified failed-import wording and standalone collect_env.py execution instructions, and rephrased related documentation and comments without changing functionality.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is just the template with no filled-in summary, why, issues, impact, or testing details. Fill in each required section with the actual change summary, motivation, related issues, compatibility impact, and testing performed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the documented scope: improving wording in the environment report docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 419fa5ad-3f66-47df-b1a2-fc9e512506f6

📥 Commits

Reviewing files that changed from the base of the PR and between 3041f3e and 6238312.

📒 Files selected for processing (3)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • README.md
  • python/cudnn/collect_env.py

Comment thread python/cudnn/collect_env.py Outdated
@liujane-dev liujane-dev self-assigned this Jul 20, 2026
@liujane-dev
liujane-dev requested a review from Anerudhan July 20, 2026 07:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant