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 two new reaction metadata #852

Merged
merged 2 commits into from
May 23, 2024
Merged

Add two new reaction metadata #852

merged 2 commits into from
May 23, 2024

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented May 20, 2024

I have added two more Reaction metadata that we support with getters:

  • description
  • misc

There are two main uses of this PR:

  • These two metadata should be usable by the user to support any metadata they would like to use, without us having to support the addition of user-designated metadata.
  • They are good metadata to introduce the concept of reaction metadata in the docs (rather than noise scaling, which is non-obvious what it is). This way I do not have to introduce Reaction metadata in the SDE tutorials.

@TorkelE TorkelE changed the title dd two new reaction metadata Add two new reaction metadata May 20, 2024
Copy link
Member

@isaacsas isaacsas left a comment

Choose a reason for hiding this comment

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

Adding a 'misc' metadata seems redundant? Isn't metadata itself the misc of a Reaction?

@TorkelE
Copy link
Member Author

TorkelE commented May 21, 2024

Yes, ish.

It is redundant if we advice the users that they can add whatever metadata they want themselves. However, since we right now don't do that, I figured this was an easy workaround (without actually looking like it). I.e. whatever metadata a user wants to add they can just stick in the misc field.

In practise, I looked through the metadata permitted for symbolic variables and picked misc and description from that list as they seemed to make sense as easy implementation for Reaction metadata.

@TorkelE TorkelE merged commit 080b89f into master May 23, 2024
5 of 6 checks passed
@TorkelE TorkelE deleted the new_reaction_metadata branch May 23, 2024 16:42
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.

None yet

2 participants