LCORE-1229: updated instructions for Claude

[tisnik]

Description

LCORE-1229: updated instructions for Claude

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

• Assisted-by: N/A
• Generated by: N/A

Related Tickets & Documents

• Related Issue #LCORE-1229

Summary by CodeRabbit

• Documentation
  • Updated function parameter documentation wording for consistency and clarity.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation wording updated in CLAUDE.md where Google-style docstring parameter section was changed from "Args:" to "Parameters:" designation.

Changes

Cohort / File(s)	Change Summary
Documentation Update CLAUDE.md	Updated Google-style docstring parameter documentation heading from "Args:" to "Parameters:"

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• adds instructions for Claude #530: Both PRs modify CLAUDE.md documentation file—one introduces the initial file with coding guidelines, while this PR updates docstring wording conventions within it

Suggested labels

ok-to-test

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The PR title 'LCORE-1229: updated instructions for Claude' is vague and generic, using non-descriptive language that doesn't clearly convey what specific documentation changes were made.	Consider a more specific title like 'Update Claude docstring parameter documentation from Args to Parameters' that clearly describes the actual change made.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@CLAUDE.md`:
- Line 115: Replace the docstring section header "Parameters:" with "Args:" in
the CLAUDE.md docstring guidance so it matches the Google Python Style Guide;
specifically update the occurrence of the literal "Parameters:" (around the
function parameter documentation example) to "Args:" and ensure any accompanying
examples or explanatory text use the "Args:" label consistently.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

cat -n CLAUDE.md | sed -n '110,120p'

Repository: lightspeed-core/lightspeed-stack

Length of output: 567

---

🏁 Script executed:

cat -n CLAUDE.md | sed -n '100,130p'

Repository: lightspeed-core/lightspeed-stack

Length of output: 1631

---

🌐 Web query:

Google Python Style Guide docstring function parameters section name Args vs Parameters

💡 Result:

In the Google Python Style Guide, the function-parameter section heading is Args: (not Parameters:). It explicitly says “Certain aspects of a function should be documented in special sections” and then defines Args: as the place to “List each parameter by name.” [1] (See also the same guidance in the Markdown version.) [2]

Answer: Use Args:. [1][2]

---

Use Args: instead of Parameters: to match Google Python Style Guide.

Line 112 explicitly states to follow Google Python docstring conventions, which designate Args: (not Parameters:) as the section for documenting function parameters. Line 115 must be updated to align with this standard.

Fix

-  - `Parameters:` for function parameters
+  - `Args:` for function parameters

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	- `Parameters:` for function parameters
	- `Args:` for function parameters

🤖 Prompt for AI Agents

In `@CLAUDE.md` at line 115, Replace the docstring section header "Parameters:"
with "Args:" in the CLAUDE.md docstring guidance so it matches the Google Python
Style Guide; specifically update the occurrence of the literal "Parameters:"
(around the function parameter documentation example) to "Args:" and ensure any
accompanying examples or explanatory text use the "Args:" label consistently.