-
Notifications
You must be signed in to change notification settings - Fork 5
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
Truncate semantic pointer names to 1 KB #246
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM.
Static checks are failing though because the commit message "body is too short". I think it is fine, but probably something that needs to be fixed on the nengo-bones side?
We may make that change in nengo-bones at some point. For now, though, I would recommend just changing the message to e.g. "This commit fixes #???" so that it's long enough. |
We did decide to remove the commit body minimum length, but it'll take some time before that change is done as it's a ways down our priority list. What I would do is copy in the context that is in the first post of this PR into the commit message. What's the harm in having additional context in the commit message body? |
Done. |
Trying again. |
Trying again.. |
Trying again... |
It passed (unblocked)! |
Note: will need to drop the last two commits after #252. |
Fixes #244. 1 KB seems long enough to capture the majority of use cases where someone might want to read the name, while being a cheap amount of memory relative to the resource requirements of the semantic pointer itself and how it will be used.
Motivation and context:
Fixes #244. 1 KB was chosen somewhat arbitrarily, but it seems long enough to capture the majority of use cases where someone might want to read the name, while being a cheap amount of memory relative to the resource requirements of the semantic pointer itself and how it will be used.
I considered adding a warning, but it didn't seem important enough to let the user know (the fact that the name is being truncated seems inconsequential for most users)?
How has this been tested?
Added a unit test similar to the reproducing example from #244.
How long should this take to review?
Types of changes:
Checklist: