-
Notifications
You must be signed in to change notification settings - Fork 2
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
Apply pulse parameters #61
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.
Could you please update the documentation in the Readme file according to your changes?
I updated the Readme a little bit, not sure how much detail you want in there: I think the code was supposed to still work as it was working before this MR. |
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.
I think for now the documentation in the README.md is enough. We should, however, implement proper documentation soon. I hope I get to that in the upcoming months.
README.md
Outdated
@@ -109,6 +108,8 @@ Alternatively, you can specify all blob parameters exactly as you want by writin | |||
`free_parameter` for vx | |||
- `vy_parameter`: float, optional, | |||
`free_parameter` for vy | |||
- `spx_parameter`: float = 0.5, |
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.
You forgot to change the variable name here. Also, remove trailing ,
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.
it is still spx_parameter in the constructor, thought of leaving it short since the others are also shortened (A_dist, etc) and changing them will make old code not work.
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.
Should I have long name for the shape parameter arguments while keeping short name for the others?
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.
Well, that's what I've done now anyway
No description provided.