curriculum/challenges/english/blocks/learn-how-to-read-and-understand-code-documentation/66000a440c2f492ddee509f9.md
Watch the video to understand the context of the upcoming lessons.
Watch the video
{
"setup": {
"background": "company2-breakroom.png",
"characters": [
{
"character": "Tom",
"position": { "x": -25, "y": 0, "z": 1 }
},
{
"character": "Sarah",
"position": { "x": 125, "y": 0, "z": 1 }
}
],
"audio": {
"filename": "7.2-2.mp3",
"startTime": 1
},
"alwaysShowDialogue": true
},
"commands": [
{
"character": "Tom",
"position": { "x": 25, "y": 0, "z": 1 },
"startTime": 0
},
{
"character": "Sarah",
"position": { "x": 70, "y": 0, "z": 1 },
"startTime": 0.5
},
{
"character": "Tom",
"startTime": 1,
"finishTime": 6.38,
"dialogue": {
"text": "I often find function descriptions in the documentation, but I'm not sure how to interpret them.",
"align": "left"
}
},
{
"character": "Tom",
"startTime": 6.62,
"finishTime": 8.62,
"dialogue": {
"text": "What should I focus on when I'm reading these?",
"align": "left"
}
},
{
"character": "Sarah",
"startTime": 9.3,
"finishTime": 13.86,
"dialogue": {
"text": "That's a great question. First, you should pay attention to the function's name and parameters.",
"align": "right"
}
},
{
"character": "Sarah",
"startTime": 14.2,
"finishTime": 17.68,
"dialogue": {
"text": "It can give you an idea of what the function does and how to use it.",
"align": "right"
}
},
{
"character": "Tom",
"startTime": 17.82,
"finishTime": 20.28,
"dialogue": {
"text": "Got it. Is there anything else I should keep in mind?",
"align": "left"
}
},
{
"character": "Sarah",
"startTime": 21.1,
"finishTime": 25.68,
"dialogue": {
"text": "Absolutely. You should look for a description of what the function does and any return values.",
"align": "right"
}
},
{
"character": "Sarah",
"startTime": 26.28,
"finishTime": 29.02,
"dialogue": {
"text": "Also, check for any examples or code snippets.",
"align": "right"
}
},
{
"character": "Sarah",
"startTime": 29.02,
"finishTime": 32.16,
"dialogue": {
"text": "They can help you illustrate how to use the function effectively.",
"align": "right"
}
},
{
"character": "Tom",
"startTime": 32.9,
"finishTime": 34.22,
"dialogue": {
"text": "Great tips. Thanks a lot.",
"align": "left"
}
},
{
"character": "Sarah",
"position": { "x": 125, "y": 0, "z": 1 },
"startTime": 34.72
},
{
"character": "Tom",
"position": { "x": -25, "y": 0, "z": 1 },
"startTime": 35.22
}
]
}