docs: fix inconsistent parameter name in CLI help text

[cxxCoolStar]

User description

Description

Fixed inconsistent parameter naming in CLI help text.

Changes

• Updated usage examples to use --pr_url instead of --pr-url
• This matches the actual parameter name used throughout the codebase

Type of Change

• Documentation fix

---

PR Type

Documentation, Tests

---

Description

• Fixed inconsistent CLI parameter naming from --pr-url to --pr_url

• Added test script for GitHub provider URL parsing validation

---

Diagram Walkthrough

flowchart LR
  A["CLI Help Text"] -- "parameter name consistency" --> B["--pr_url format"]
  C["GitHub URL Parser"] -- "validation script" --> D["URL parsing tests"]

Loading

File Walkthrough

	Relevant files
Documentation	cli.py Standardize CLI parameter name in help text                            pr_agent/cli.py Updated usage example in CLI help text from --pr-url to --pr_url Ensures consistency with actual parameter name used in codebase Fixes documentation inconsistency in argparse usage string +1/-1
Tests	verify_github_provider_url_parse.py Add GitHub URL parsing verification script                              scripts/verify_github_provider_url_parse.py Added new test script for GitHub provider URL parsing Supports multiple GitHub URL formats (REST API, HTML, GitHub Enterprise) Parses and validates PR URLs to extract repository name and PR number Includes example URLs for testing different GitHub URL patterns +47/-0

---

[qodo-merge-for-open-source]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Consistent Naming Conventions Objective: All new variables, functions, and classes must follow the project's established naming standards Status: Passed
	No Dead or Commented-Out Code Objective: Keep the codebase clean by ensuring all submitted code is active and necessary Status: Passed
	Robust Error Handling Objective: Ensure potential errors and edge cases are anticipated and handled gracefully throughout the code Status: Passed
	Single Responsibility for Functions Objective: Each function should have a single, well-defined responsibility Status: Passed
	When relevant, utilize early return Objective: In a code snippet containing multiple logic conditions (such as 'if-else'), prefer an early return on edge cases than deep nesting Status: Passed
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-merge-for-open-source]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	PR scope includes an unrelated script The PR, intended to fix a documentation typo in pr_agent/cli.py, also introduces a new, unrelated script scripts/verify_github_provider_url_parse.py. The suggestion is to remove this script to keep the PR focused on a single change. Examples: pr_agent/cli.py [17] Usage: cli.py --pr_url=<URL on supported git hosting service> <command> [<args>]. scripts/verify_github_provider_url_parse.py [1-47] import sys from urllib.parse import urlparse def parse_pr_url(pr_url: str): parsed_url = urlparse(pr_url) # Normalize GitHub Enterprise API v3 URLs if parsed_url.path.startswith('/api/v3'): parsed_url = urlparse(pr_url.replace('/api/v3', '')) ... (clipped 37 lines) Solution Walkthrough: Before: # pr_agent/cli.py def set_parser(): parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage= """\ Usage: cli.py --pr_url=<URL on supported git hosting service> <command> [<args>]. ... """) ... # scripts/verify_github_provider_url_parse.py # (new file added) def parse_pr_url(pr_url: str): # ... logic to parse different GitHub URL formats ... return repo_name, pr_number if __name__ == '__main__': # ... test the function with example URLs ... After: # pr_agent/cli.py def set_parser(): parser = argparse.ArgumentParser(description='AI based pull request analyzer', usage= """\ Usage: cli.py --pr_url=<URL on supported git hosting service> <command> [<args>]. ... """) ... # scripts/verify_github_provider_url_parse.py # (This file is removed from the PR) Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies that the PR includes an unrelated file (scripts/verify_github_provider_url_parse.py) which is outside the stated scope of fixing a documentation typo, and recommends its removal to maintain atomic changes.	Medium
Learned best practice	Normalize hostname validation properly Normalize hostname checks using urlparse().hostname and avoid brittle string checks like 'api.github.com' in parsed_url.netloc. Use lowercase comparison and check the parsed hostname attribute directly to prevent false matches in paths or query strings. scripts/verify_github_provider_url_parse.py [6-15] parsed_url = urlparse(pr_url) +hostname = (parsed_url.hostname or "").lower() # Normalize GitHub Enterprise API v3 URLs if parsed_url.path.startswith('/api/v3'): parsed_url = urlparse(pr_url.replace('/api/v3', '')) path_parts = parsed_url.path.strip('/').split('/') # GitHub REST API form: https://api.github.com/repos/<owner>/<repo>/pulls/<number> -if 'api.github.com' in parsed_url.netloc or '/api/v3' in pr_url: +if hostname == 'api.github.com' or '/api/v3' in pr_url: Apply / Chat Suggestion importance[1-10]: 6 __ Why: Relevant best practice - Normalize and validate external-facing inputs (URL formats, hostnames) before use; pre-parse and sanitize once per operation to avoid repeated calls and brittle string checks.	Low
Update

• Author self-review: I have reviewed the PR code suggestions, and addressed the relevant ones.

[cxxCoolStar]

Note: I have revised the PR as required,but i cannot check the boxes in the qodo-merge-for-open-source they are disabled: