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.

Sign up for GitHub

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

Jump to bottom

[DOC] docs update part 1 #123

Merged
merged 25 commits into from
Nov 16, 2020
Merged

[DOC] docs update part 1 #123

merged 25 commits into from
Nov 16, 2020

Conversation

marcobarilari
Copy link
Collaborator

No description provided.

@marcobarilari marcobarilari added the documentation Improvements or additions to documentation label Nov 16, 2020
marcobarilari
marcobarilari commented Nov 16, 2020
View reviewed changes
src/createFilename.m Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Nov 16, 2020 •
edited

Codecov Report

❗ No coverage uploaded for pull request base (doc@ab71a6c). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##             doc     #123   +/-   ##
======================================
  Coverage       ?   81.00%           
======================================
  Files          ?       29           
  Lines          ?      616           
  Branches       ?        0           
======================================
  Hits           ?      499           
  Misses         ?      117           
  Partials       ?        0
Flag Coverage Δ
unittests 81.00% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ab71a6c...13c2dee. Read the comment docs.

Remi-Gau
Remi-Gau reviewed Nov 16, 2020
View reviewed changes
src/createDataDictionary.m
@@ -2,29 +2,18 @@

function createDataDictionary(cfg, logFile)
%
% Short description of what the function does goes here.
% It creates the data dictionary to be associated with a _events.tsv file. It will create empty
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that in the long term this function should be able to write the dictionary for a wider variety of data files and not just events file. At least stim files too. Hopefully. 😉

src/createDataDictionary.m
@@ -2,29 +2,18 @@

function createDataDictionary(cfg, logFile)
%
% Short description of what the function does goes here.
% It creates the data dictionary to be associated with a _events.tsv file. It will create empty
Copy link
Contributor

Choose a reason for hiding this comment

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

Also the function can use the content of cfg to create those data dictionary so it will only create empty fields if the user has not set them before.

src/createFilename.m Outdated Show resolved Hide resolved
src/createFilename.m Outdated Show resolved Hide resolved
src/readAndFilterLogfile.m Outdated Show resolved Hide resolved
@marcobarilari marcobarilari marked this pull request as draft November 16, 2020 13:13
Remi-Gau
Remi-Gau requested changes Nov 16, 2020
View reviewed changes
src/gui/getIsQuestionToAsk.m Outdated Show resolved Hide resolved
src/gui/getIsQuestionToAsk.m Outdated Show resolved Hide resolved
src/gui/getIsQuestionToAsk.m Outdated Show resolved Hide resolved
marcobarilari and others added 8 commits November 16, 2020 16:07
@marcobarilari
update docs for askUserCli
404510f
@marcobarilari
update docs for askUserGui
e2655ad
@marcobarilari @Remi-Gau
Update src/createFilename.m
ce9a437 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/createFilename.m
0140c9a 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/getIsQuestionToAsk.m
58386c1 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/getIsQuestionToAsk.m
90b4240 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/getIsQuestionToAsk.m
fdd6abc 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/readAndFilterLogfile.m
c882c48 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari marcobarilari marked this pull request as ready for review November 16, 2020 15:39
Remi-Gau
Remi-Gau requested changes Nov 16, 2020
View reviewed changes
src/createFilename.m
%
% The behavior of this function depends on:
% - ``cfg.testingDevice``:
% - set to ``pc`` (dummy try) or ``beh`` can work for behavioral experiment.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think at the moment we only accept pc but it would make sense to have beh as well I think. Feel free to open an issue so we remember to do that.

src/gui/askForGroupAndOrSession.m Outdated Show resolved Hide resolved
src/gui/askUserCli.m Outdated Show resolved Hide resolved
src/gui/askUserGui.m Outdated Show resolved Hide resolved
src/gui/createQuestionList.m Outdated Show resolved Hide resolved
src/gui/createQuestionList.m Outdated Show resolved Hide resolved
src/gui/setDefaultResponses.m Outdated Show resolved Hide resolved
src/gui/setDefaultResponses.m Outdated Show resolved Hide resolved
marcobarilari and others added 7 commits November 16, 2020 16:57
@marcobarilari @Remi-Gau
Update src/gui/setDefaultResponses.m
c77017b 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/setDefaultResponses.m
822965a 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/createQuestionList.m
42c8859 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/createQuestionList.m
07ab932 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/askUserGui.m
13f8b40 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/askUserCli.m
5f6be6b 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
@marcobarilari @Remi-Gau
Update src/gui/askForGroupAndOrSession.m
13c2dee 
Co-authored-by: Remi Gau <remi_gau@hotmail.com>
Remi-Gau
Remi-Gau approved these changes Nov 16, 2020
View reviewed changes
Copy link
Contributor

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

Good to go: 🚀 🎉 🧙‍♂️

@marcobarilari marcobarilari mentioned this pull request Nov 16, 2020
Closed
@marcobarilari marcobarilari merged commit 57cc55e into cpp-lln-lab:doc Nov 16, 2020
@marcobarilari marcobarilari deleted the marco_dockhaton branch November 16, 2020 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Remi-Gau Remi-Gau Remi-Gau approved these changes

@anege anege Awaiting requested review from anege

@CerenB CerenB Awaiting requested review from CerenB

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@marcobarilari @Remi-Gau