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

Add technical note and caveats of data objects #115

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

Conversation

glopesdev
Copy link
Member

This PR adds an extra technical note about dynamic data object type signatures and a warning about their caveats and limitations regarding serialization and custom scripting extensions.

@glopesdev glopesdev added the documentation Improvements or additions to documentation label Jan 9, 2025
@banchan86
Copy link
Contributor

Hmm I have some trouble understanding what is going on in the first note, would it help to add an example bonsai workflow?

articles/scripting-expressions-overview.md Show resolved Hide resolved
The example above projects the two unnamed items of a tuple into a new data object with an `X` and a `Y` property.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think I would include a short one line Tip on what are the cases where these dynamic classes are suited for. I would include operators that leverage attribute names (Writers and Visualizers) and general code sanitization where dynamic classes are serve to increase readability of workflows.

@bruno-f-cruz
Copy link
Collaborator

Hmm I have some trouble understanding what is going on in the first note, would it help to add an example bonsai workflow?

New (1 as Foo, "a" as Bar) != new("a" as Bar, 1 as Foo). These would be two distinct dynamic classes.

However if the order is the same, they evaluate to the same ephemeral type.

@banchan86
Copy link
Contributor

Hmm I have some trouble understanding what is going on in the first note, would it help to add an example bonsai workflow?

New (1 as Foo, "a" as Bar) != new("a" as Bar, 1 as Foo). These would be two distinct dynamic classes.

However if the order is the same, they evaluate to the same ephemeral type.

ah ok i got it now!

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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants