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

Update terms to glossary #121

Merged
merged 2 commits into from
Jan 20, 2021
Merged

Update terms to glossary #121

merged 2 commits into from
Jan 20, 2021

Conversation

tab-cmd
Copy link
Contributor

@tab-cmd tab-cmd commented Jan 13, 2021

Overview

Update sequence to inquiry and epoch to series

Ticket

https://www.pivotaltracker.com/story/show/176097858

Contributions

Too many to list. Replaced all usage of sequence or seq with inq. Replaced all usage of epoch or epochs with series.

Test

  • Run pytest
  • Run all tasks in fake data mode

Documentaion

  • Are documentation updates required? In-line, README, or documentation? Verify the updates you did here. Updated where appropriate

@tab-cmd tab-cmd requested review from lawhead and AlisterD January 14, 2021 23:31
"value": "1",
"section": "bci_config",
"readableName": "Minimum Sequence Length",
"helpTip": "The minimum number of sequences to present in spelling tasks",
"readableName": "Minimum inquiry Length",
Copy link
Collaborator

Choose a reason for hiding this comment

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

You might want to capitalize 'inquiry' here for consistency.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nice catch - I tried to find them all but I knew a few would slip through!

@lawhead
Copy link
Collaborator

lawhead commented Jan 15, 2021

Do we have the glossary terms defined anywhere in the code base? If not we may want to include them in one of the READMEs. Also, in our Contribution Guidelines have a bullet point to Use informative names for functions and classes. We may want to expand this to mention using the appropriate terminology (as defined in the glossary) when possible.

@tab-cmd tab-cmd force-pushed the update-terms-to-glossary branch from a0767b8 to 87a13f9 Compare January 15, 2021 20:18
@tab-cmd tab-cmd force-pushed the update-terms-to-glossary branch from 87a13f9 to c0eaeb3 Compare January 15, 2021 21:19
@@ -71,7 +71,7 @@ make dev-install

Start by running `python bcipy/gui/BCInterface.py` in your command prompt or terminal. You may also invoke the experiment directly using command line tools for bci_main.py.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to create a make command for this as well?

# Schedule a sequence
rsvp.stimuli_sequence = ele_sti[counter]
# Schedule a inquiry
rsvp.stimuli_inquiry = ele_sti[counter]
Copy link
Contributor

Choose a reason for hiding this comment

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

Good change to keep it clean start with definition

@@ -122,23 +122,23 @@ def best_case_rsvp_seq_gen(alp: list,
First element is the target, second element is the fixation
Observe that [-1] element represents the trial information
Copy link
Contributor

Choose a reason for hiding this comment

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

good explanation here

@tab-cmd tab-cmd merged commit 00884e2 into 1.4.3 Jan 20, 2021
@tab-cmd tab-cmd mentioned this pull request Jan 20, 2021
4 tasks
@tab-cmd tab-cmd deleted the update-terms-to-glossary branch April 16, 2021 21:30
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