Skip to content

Conversation

@Bill-hbrhbr
Copy link
Collaborator

@Bill-hbrhbr Bill-hbrhbr commented Mar 22, 2025

Description

As title, add the missing suffix _HPP to the header guards in ystdlib-cpp/src/ystdlib/containers/Array.hpp.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

  • No functionality changes.

Summary by CodeRabbit

  • Chores
    • Made internal updates to bolster system safeguards and ensure reliable operations without affecting user-facing functionality.

@Bill-hbrhbr Bill-hbrhbr requested a review from a team as a code owner March 22, 2025 06:49
@coderabbitai
Copy link

coderabbitai bot commented Mar 22, 2025

Walkthrough

This pull request modifies the include guard macros in the Array.hpp header file. The updated macros now incorporate the file extension (.hpp), changing both the opening and closing guards from YSTDLIB_CONTAINERS_ARRAY to YSTDLIB_CONTAINERS_ARRAY_HPP.

Changes

File Change Summary
src/ystdlib/containers/Array.hpp Updated include guard macros to include the file extension, replacing YSTDLIB_CONTAINERS_ARRAY with YSTDLIB_CONTAINERS_ARRAY_HPP.

Possibly related PRs

Suggested reviewers

  • LinZhihao-723
  • davidlion

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.


📜 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 5f43a3b and 0739d50.

📒 Files selected for processing (1)
  • src/ystdlib/containers/Array.hpp (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}`: - Prefer `false == ` rather than `!`.

**/*.{cpp,hpp,java,js,jsx,tpp,ts,tsx}: - Prefer false == <expression> rather than !<expression>.

  • src/ystdlib/containers/Array.hpp
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: lint-check (ubuntu-24.04)
  • GitHub Check: lint-check (macos-15)
🔇 Additional comments (2)
src/ystdlib/containers/Array.hpp (2)

1-2: Header Guard Correction Confirmed

The updated header guard macros now correctly include the _HPP suffix. This change improves uniqueness and adheres to our naming conventions and coding standards.


122-123: Header Guard Closure Verified

The closing #endif and its accompanying comment have been updated to match the new guard name. This correctly prevents multiple inclusions of the header.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Bill-hbrhbr Bill-hbrhbr changed the title fix(containers): Correct header guard for ystdlib::containers::Array's header file. fix(containers): Correct header guards for ystdlib::containers::Array's header file. Mar 22, 2025
@Bill-hbrhbr Bill-hbrhbr changed the title fix(containers): Correct header guards for ystdlib::containers::Array's header file. fix(containers): Correct header guards in ystdlib/containers/Array.hpp. Mar 24, 2025
@Bill-hbrhbr Bill-hbrhbr merged commit d70e210 into y-scope:main Mar 24, 2025
12 checks passed
@Bill-hbrhbr Bill-hbrhbr deleted the fix-array-header-guard branch March 24, 2025 04:11
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