Skip to content

DOC-3231 Clarify projectKey parameter wording in README#324

Open
kevin-hinz wants to merge 1 commit intomasterfrom
kh/doc-3231
Open

DOC-3231 Clarify projectKey parameter wording in README#324
kevin-hinz wants to merge 1 commit intomasterfrom
kh/doc-3231

Conversation

@kevin-hinz
Copy link
Copy Markdown
Contributor

Summary

Standardizes the language used to describe the projectKey parameter across all tools in the README.

  • Replaces "omitted when SONARQUBE_PROJECT_KEY is configured" with "(Ignored when SONARQUBE_PROJECT_KEY is defined)" for consistency
  • Adds the missing ignored note to search_security_hotspots and list_pull_requests, which were previously not indicating that SONARQUBE_PROJECT_KEY supersedes the parameter

@kevin-hinz kevin-hinz requested a review from nquinquenel April 7, 2026 13:41
@sonar-review-alpha
Copy link
Copy Markdown

Summary

This PR standardizes the wording used to describe how the SONARQUBE_PROJECT_KEY environment variable overrides the projectKey parameter across all tools in the README.

All instances of "(omitted when SONARQUBE_PROJECT_KEY is configured)" are changed to "(Ignored when SONARQUBE_PROJECT_KEY is defined)" for consistency. The change also fills gaps in two tools (search_security_hotspots and list_pull_requests) that were missing this note entirely—these now correctly document the environment variable override behavior.

What reviewers should know

Scope: Changes are confined to README documentation only—no code changes.

Two types of changes to verify:

  1. Wording updates (most tools): "omitted" → "Ignored", "is configured" → "is defined"—verify language is now consistent throughout
  2. Additions (2 tools): search_security_hotspots and list_pull_requests now document the environment variable override—check that these additions accurately reflect actual tool behavior

Key files: Single file modified (README.md) across lines 903–1072 in the parameter documentation sections.


  • Generate Walkthrough
  • Generate Diagram

🗣️ Give feedback

@hashicorp-vault-sonar-prod
Copy link
Copy Markdown

hashicorp-vault-sonar-prod bot commented Apr 7, 2026

DOC-3231

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 7, 2026

Copy link
Copy Markdown
Member

@nquinquenel nquinquenel left a comment

Choose a reason for hiding this comment

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

Thanks!

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.

2 participants