# MPHY0021 - Day 6 (18th November 2021)

:::info
## :tada: Welcome to the sixth day! :books: Documentation, Finding Errors and Debugging

### Today
Today we will look at
- :books: Documentation - what makes it important and how to include it
- :stopwatch::bug: Using `git bisect` to find errors in history
- :mag::bug: Using a debugger
:::

### :stopwatch: Time keeper
- [name=Yahya] :raised_hand: 5' before the end.
- 10:00 - 10:50
- 11:10 - 11:55
- 12:05 - 12:55

#### What was discussed during the last 2 weeks :newspaper:
- A lot of questions about the assignment
- There's a [FAQ on the forum](https://moodle.ucl.ac.uk/mod/forum/discuss.php?d=668901)
- We have increased the number of office hours for today, tomorrow and Monday.
- Remember, Submitty will only be available till Monday morning.
- Feedback survey
- 😞 very little number of responses
- 🎉 Thanks to the ones who filled it in!
- UCU call to strike
- Why is it happening?
- [Four fights](https://www.ucu.org.uk/article/11818/Four-fights-dispute-FAQs)
- [Pensions](https://www.ucu.org.uk/strikeforuss)
- how may it affect this course?
- 1 lesson (that lesson won't be recovered).
- It may also produced delays releasing the marks.

### Review from last lesson
- Testing and homework exercises about testing
- Documentation homework
- doctest
- sphinx
- Debugging homework
- bisect

### Groups :handshake:

We will be using the breakout rooms functionality of Zoom.
We have the following groups, and each group have its own document. Each week you will be in a randomly allocated group.

Once in your breakout-room, find who is chairing that room and open the document linked to that group.

:::danger
Remember to `rename` yourself by clicking on your Zoom name (in the participants list) and change it to:
`SGX - Your name` being `X` the number of the group you have been assigned to.

If you disconnect and connect again, please rename yourself again.
:::

- [Breakout Room 1 (Haroon)](/dIqsFfshT7SIRqW-9so2DQ) - Groups 1-5
- [Breakout Room 2 (David)](/Igegy-tXQ_6MtDIBgUQPnA)- Groups 6-10
- [Breakout Room 3 (Alessandro) ](/tHEl2VEJRKyIT0cs_dMbSg) - Groups 11-15
- [Breakout Room 4 (Nina)](/vhDj9stFTHOK_3vwIZh3Rg) - Groups 16-20
- [Breakout Room 5 (Matt) ](/haojmUiqQg6bqJaxcJIxSg) - Groups 21-25
- [Breakout Room 6 (Nisha) ](/V_tqDbQnQ8Wrc3t4XilMSQ) - Groups 26-30
- [Breakout Room 7 (Stef & Anastasis) ](/zyQ6M37gQ4SoVuGuYbRglw) - Groups Others

---
### Documentation

#### Introduction & Overview of Homework

#### Poll: Understanding Documentation

:::info
Let's have a look at what you all know about documentation already.
Go to the [voting page](https://www.menti.com/j89jojiiqy)!
:::

#### Exercise: Looking at Project Documentation

:::info
For this exercise you'll be looking at a single project in small breakout rooms - your task is to look at them from a usability perspective.

Consider things such as ability to understand the project's purpose, how to use it, how you might contribute to it, and where to find help if things go wrong.

Once in your breakout room open the corresponding link below. In each case you'll start on the PyPI page, but do go to the source and website/documentation links:

* Groups 1 - 2: [spacy](https://pypi.org/project/spacy/)
* Groups 3 - 4: [matplotlib](https://pypi.org/project/matplotlib/)
* Groups 5+: [numpy](https://pypi.org/project/numpy/)

:::

#### Discussion of Looking at Project Documentation

In larger groups, discuss the projects you looked at. For example:
* What did you find confusing or useful?
* What were your thoughts about how the information was presented?

Choose one person from the group to add notes below about the projects and what you discussed.

- Group 1:
- ​
- Group 2:
- 101?
- Changelog
- Group 3:
- ​
- Group 4:
- ​
- Group 5:
- ​
- Group 6:
- ​
- Group 7:
- ​

---

### Bisect

### Review the manual bisect

- [mentimenter quiz](https://www.menti.com/eztxvsdm1i)
- RSE-Classwork repo: [:hash::two::five:](https://github.com/UCL-MPHY0021-21-22/RSE-Classwork/issues/25)

### Exercise: :brain: automate the bisect process

We will work for over 6 issues (:hash::two::six:-:hash::three::one:), spending no more than 10' in each. Half-way through we will come all together to the main room.

:::info

Let's start!

RSE-Classwork repo: [:hash::two::six:](https://github.com/UCL-MPHY0021-21-22/RSE-Classwork/issues/26)

If you need help, you can ask for us to drop in, following [these instructions](https://www.youtube.com/watch?v=yIOMPRLQIHA).
:::

---
### Debugging demo

### Next week
- Argparse, Packaging, and linting

# Questions

:::info
Feel free to add any question below. Remember the syntax:

- Example question
  - [name=student_a] Example answer
  - [name=TA_1] Example answer

:::

- .
- [name=...]
- .
- [name=...]
- .
- [name=...]

###### tags: `mphy0021` `teaching` `class`