这是indexloc提供的服务，不要输入任何密码
Skip to content

style: replace unkeyed struct literals with keyed fields #378

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

style: replace unkeyed struct literals with keyed fields #378

wants to merge 1 commit into from

Conversation

Himess
Copy link

@Himess Himess commented Mar 25, 2025

Description

Replaced unkeyed struct literals with keyed fields in test files to comply with go vet and golint requirements.

Before

Running go vet ./... caused the following error:

struct literal uses unkeyed fields

Before

After

The issue is resolved after the changes:

After

No functionality was changed. This is a formatting-only change.

Author Checklist

  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

@Himess Himess requested a review from a team as a code owner March 25, 2025 17:51
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Mar 25, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request reformats test definitions in the distribution module's pool tests. In particular, the tests for the IsAnyNegativePools and TruncatePools functions have been restructured. Negative pool tests now explicitly specify field names, and pool truncation tests explicitly detail the fields within both DecPool and Pool structures. These changes improve clarity and maintain the original test logic without altering functionality. No changes were made to exported or public entities.

Changes

File(s) Change Summary
x/distribution/types/decpool_test.go Reformatted tests for both IsAnyNegativePools and TruncatePools by expanding inline structures into explicit field names for enhanced readability.

Poem

I hop through lines of well-formed code,
Where tests are clear along each structured node.
Fields are named and logic stays intact,
In the realm of pools, there’s nothing we lack.
A joyful rabbit cheers with glee 🐇,
Celebrating clarity as far as the eye can see!

📜 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 e4fadc4 and 5eebb10.

📒 Files selected for processing (1)
  • x/distribution/types/dec_pool_test.go (2 hunks)
🔇 Additional comments (2)
x/distribution/types/dec_pool_test.go (2)

223-228: Properly formatted struct literals using keyed fields.

The change from unkeyed to keyed fields improves code readability and ensures compliance with go vet and golint requirements as mentioned in the PR objectives. The functionality remains unchanged.

302-357: LGTM! Well-structured test case definition with keyed fields.

The test case definition has been properly reformatted to use keyed fields throughout all nested structs, making the code more explicit and maintainable. This change maintains the same functionality while satisfying the Go linting requirements.

✨ 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 plan to trigger planning for file edits and PR creation.
  • @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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Himess