Skip to content

Conversation

@GongJr0
Copy link
Owner

@GongJr0 GongJr0 commented Oct 4, 2025

Replaced en dashes with hyphens in docstrings and comments for consistency and clarity, particularly in references to Newey-West and Benjamini-Hochberg methods.

Summary by CodeRabbit

  • Documentation
    • Standardized terminology in docstrings (consistent Newey-West/HAC references and hyphenation) for improved readability.
    • Clarified parameter descriptions and wording for greater clarity and consistency.
    • No changes to behavior, calculations, or results; functionality remains identical.

Replaced en dashes with hyphens in docstrings and comments for consistency and clarity, particularly in references to Newey-West and Benjamini-Hochberg methods.
@GongJr0 GongJr0 added the documentation Improvements or additions to documentation label Oct 4, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 4, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

Docstrings in CandleNet/autoreg/lag_utils.py were updated to standardize “Newey-West/HAC” terminology and tweak parameter descriptions. No code logic, control flow, or interfaces were changed.

Changes

Cohort / File(s) Summary
Docstring standardization
CandleNet/autoreg/lag_utils.py
Replaced “Newey–West” with “Newey-West” in docstrings; minor wording edits in parameter descriptions; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A hop and a pause, I tidy the prose,
Dashes aligned where the Newey-West goes.
No loops were disturbed, no branches were bent,
Just whiskers and words in tidy content.
Thump-thump—docs groomed, I nibble a rose.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch FeatureGen

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ccd931a and 7b7624e.

📒 Files selected for processing (1)
  • CandleNet/autoreg/lag_utils.py (4 hunks)

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

@GongJr0 GongJr0 added this to CandleNet Oct 4, 2025
@GongJr0 GongJr0 merged commit f6f6859 into main Oct 4, 2025
5 of 6 checks passed
@github-project-automation github-project-automation bot moved this to Done in CandleNet Oct 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

1 participant