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

RSDK-10084 - Add documentation warning for embedded structs in NativeConfig #4819

Merged
merged 2 commits into from
Feb 27, 2025

Conversation

cheukt
Copy link
Member

@cheukt cheukt commented Feb 26, 2025

No description provided.

@cheukt cheukt requested a review from benjirewis February 26, 2025 20:45
@viambot viambot added the safe to test This pull request is marked safe to test from a trusted zone label Feb 26, 2025
Copy link
Member

@benjirewis benjirewis left a comment

Choose a reason for hiding this comment

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

Thanks!

To be clear, it's not really NativeConfig that's the issue, right? NativeConfig is just doing a type cast. It's really the default AttributeMapConverter that gets borked with embedded structs? And, we're calling NativeConfig on that borked thing?

With that said, from a module developer perspective, I guess they'll run into what @njooma ran into with NativeConfig, so this is where they'll encounter the issue. So placement seems fine, but comment might be slightly misleading.

@cheukt cheukt requested a review from benjirewis February 27, 2025 19:29
@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Feb 27, 2025
@cheukt
Copy link
Member Author

cheukt commented Feb 27, 2025

updated the docstring, happy to hear any suggestions on wording if this is still a bit misleading

Copy link
Member

@benjirewis benjirewis left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks.

@cheukt cheukt merged commit d8f9eda into main Feb 27, 2025
16 checks passed
@cheukt cheukt deleted the warning-native-config branch February 27, 2025 20:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants