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

Renamed potentially confusing variables #137

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

jschepers
Copy link
Collaborator

@jschepers jschepers commented Feb 3, 2025

Since @maanikmarathe, @behinger, and I discussed, that some variable names in simulation.jl are a bit confusing, I renamed them:

  • Instances of signal that were referring to a <:AbstractComponent I renamed to components or component.
  • In the add_responses! function, I renamed erpvec to trial_idx.

@maanikmarathe, do you think it's clearer now or is there still something missing?
@behinger, could you quickly check that I did not make any stupid mistakes during the renaming which breaks the code? Is naming it components okay or would you rather name it component? I thought of a vector of components therefore I named it components.

@jschepers jschepers requested a review from behinger February 3, 2025 16:16
@maanikmarathe
Copy link
Collaborator

This is definitely clearer, makes sense 👍

@jschepers jschepers merged commit f850674 into improve-docstrings Feb 5, 2025
2 checks passed
@jschepers jschepers deleted the rename-variables branch February 5, 2025 10:38
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.

3 participants