Update lab_meetings.md #28
Conversation
Update lab meeting section
Reviewer's Guide by SourceryThis pull request adds a new file 'lab_meetings.md' to the 'doc' directory, providing information about different types of lab meetings, their schedules, and related resources. File-Level Changes
Tips
|
for more information, see https://pre-commit.ci
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @EleGdt - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider standardizing the heading styles throughout the document. Currently, there's a mix of '#' and '##' being used for headings of seemingly equal importance.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 4 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
doc/lab_meetings.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| ## Lab meetings (person in charge: Eleonore Giraudet) | |||
| # Regular lab meeting | |||
There was a problem hiding this comment.
suggestion (documentation): Consider using consistent heading levels throughout the document.
The main heading uses '##' while this subheading uses '#'. Using consistent heading levels (e.g., '##' for main heading, '###' for subheadings) would improve document structure.
| # Regular lab meeting | |
| ### Regular lab meeting |
doc/lab_meetings.md
Outdated
| @@ -0,0 +1,13 @@ | |||
| ## Lab meetings (person in charge: Eleonore Giraudet) | |||
| # Regular lab meeting | |||
| At the moment, they happen every thursday at 10:30. Here you can find the [calendar](https://docs.google.com/spreadsheets/d/1aIu8WcYoRpC9p3fIiilZWTgR7i03lulYj8B5ZyUW_Qc/edit?gid=6486503#gid=6486503) and [here](https://drive.google.com/drive/folders/1Pb75jpul71mMXiP4fSZGEwK34V5meg12) the main gdrive folder where we archive relevant files. | |||
There was a problem hiding this comment.
suggestion (documentation): Remove extra space before '[calendar]' and consider restructuring the sentence for clarity.
The sentence is quite long. Consider splitting it into two sentences for better readability. For example: 'At the moment, they happen every Thursday at 10:30. You can find the [calendar] here and the main Google Drive folder for archived files [here].'
| At the moment, they happen every thursday at 10:30. Here you can find the [calendar](https://docs.google.com/spreadsheets/d/1aIu8WcYoRpC9p3fIiilZWTgR7i03lulYj8B5ZyUW_Qc/edit?gid=6486503#gid=6486503) and [here](https://drive.google.com/drive/folders/1Pb75jpul71mMXiP4fSZGEwK34V5meg12) the main gdrive folder where we archive relevant files. | |
| At the moment, they happen every Thursday at 10:30. You can find the [calendar](https://docs.google.com/spreadsheets/d/1aIu8WcYoRpC9p3fIiilZWTgR7i03lulYj8B5ZyUW_Qc/edit?gid=6486503#gid=6486503) here and the main Google Drive folder for archived files [here](https://drive.google.com/drive/folders/1Pb75jpul71mMXiP4fSZGEwK34V5meg12). |
doc/lab_meetings.md
Outdated
| They happen once a month, here you can propose and/or pick up a paper to be discussed. | ||
|
|
||
| # One slide meeting | ||
| The one slide meeting is once a month, the lab is divided in 3 batches [see here] and 1 batch will present alternatively. |
There was a problem hiding this comment.
issue (documentation): Replace '[see here]' placeholder with actual information or link.
| Each person is invited to present for ~10 minutes 1 slide and the main goal is to update the lab about his/her scientific/project progress. | ||
|
|
||
| # Method meeting | ||
| A method meeting does not necessarily happen during the LM schedule, it is called by someone who wants to discuss a specific topic that can be of interest for everyone or only a part of the lab (e.g. a softer package, fMRI analysis, running a tutorial on how to use data management). Attending a method meeting is usually not mandatory if the topic is not of your interest. |
There was a problem hiding this comment.
suggestion (documentation): Correct typo 'softer' to 'software' and define the 'LM' abbreviation.
Change 'softer package' to 'software package'. Also, 'LM' is used without being defined earlier. Consider spelling it out as 'Lab Meeting' on first use.
| A method meeting does not necessarily happen during the LM schedule, it is called by someone who wants to discuss a specific topic that can be of interest for everyone or only a part of the lab (e.g. a softer package, fMRI analysis, running a tutorial on how to use data management). Attending a method meeting is usually not mandatory if the topic is not of your interest. | |
| A method meeting does not necessarily happen during the Lab Meeting (LM) schedule. It is called by someone who wants to discuss a specific topic that can be of interest for everyone or only a part of the lab (e.g. a software package, fMRI analysis, running a tutorial on how to use data management). Attending a method meeting is usually not mandatory if the topic is not of your interest. |
| @@ -0,0 +1,13 @@ | |||
| ## Lab meetings (person in charge: Eleonore Giraudet) | |||
| # Regular lab meeting | |||
| At the moment, they happen every thursday at 10:30. Here you can find the [calendar](https://docs.google.com/spreadsheets/d/1aIu8WcYoRpC9p3fIiilZWTgR7i03lulYj8B5ZyUW_Qc/edit?gid=6486503#gid=6486503) and [here](https://drive.google.com/drive/folders/1Pb75jpul71mMXiP4fSZGEwK34V5meg12) the main gdrive folder where we archive relevant files. | |||
There was a problem hiding this comment.
Can you check that the gdrive link is working only for us?
Co-authored-by: Marco Barilari <[email protected]>
Update lab meeting section
Summary by Sourcery
Update the lab_meetings.md documentation to include comprehensive information about different types of lab meetings, their schedules, and relevant resources.
Documentation: