Skip to content

LCORE-1229: updated instructions for Claude #1061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tisnik merged 1 commit into from
Jan 26, 2026
Merged

LCORE-1229: updated instructions for Claude #1061

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ src/
- Follow Google Python docstring conventions: https://google.github.io/styleguide/pyguide.html
- Required for all modules, classes, and functions
- Include brief description and detailed sections as needed:
- `Args:` for function parameters
- `Parameters:` for function parameters
Copy link
Contributor

@coderabbitai coderabbitai bot Jan 26, 2026

Choose a reason for hiding this comment

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

⚠️ 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.

- `Returns:` for return values
- `Raises:` for exceptions that may be raised
- `Attributes:` for class attributes (Pydantic models)
Expand Down
Loading