Skip to content
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.

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

Improve handling of struct / class initializers #120

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

Conversation

g-braeunlich
Copy link

@g-braeunlich g-braeunlich commented Dec 3, 2024

Closes: #119

Summary by Sourcery

Bug Fixes:

  • Fix handling of multi-line initializers in struct/class definitions by replacing them with a placeholder.

Copy link

sourcery-ai bot commented Dec 3, 2024

Reviewer's Guide by Sourcery

The PR improves the handling of struct/class initializers by cleaning up the initializer string and providing special handling for multi-line expressions. The changes ensure better formatting and readability of initializer values in the documentation output.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Enhanced initializer string processing for better documentation output
  • Added stripping of leading spaces and equals signs from initializer strings
  • Added special handling for multi-line initializer expressions
  • Wrapped initializer values in backticks for code formatting
  • Simplified multi-line initializers to a placeholder comment
mkdoxy/property.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @g-braeunlich - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding more detail to the commit message explaining the specific improvements made to initializer handling (stripping whitespace/equals, handling multi-line expressions, code formatting)
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

- Prevent duplicated `=` chars in markdown output
- Collapse multi line expressions into a comment
- quote expressions with markdown backticks
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.

Problems due to unquoted initializers in C++ structs / classes
1 participant