Back to Freecodecamp

Task 15

curriculum/challenges/english/blocks/learn-how-to-analyze-code-documentation/66068f5b2b7dda9450a7cc2c.md

latest2.0 KB
Original Source
<!-- (Audio) Brian: Next, you should examine the function's description in the documentation. It can explain what the function does and provide usage examples. -->

--description--

Listen to the audio and answer the question.

--questions--

--text--

What is Brian's advice on using programming documentation?

--answers--

Examine the function's description in the documentation for explanations and usage examples


Memorize the function's code

--feedback--

While memorizing code can be helpful, Brian specifically mentions examining the documentation, not memorizing the code.


Change the function's code

--feedback--

Brian suggests understanding the function through its documentation, not altering its code.


Ignore the documentation

--feedback--

Ignoring the documentation goes against Brian's advice, which is to examine it for a better understanding of the function.

--video-solution--

1

--scene--

json
{
  "setup": {
    "background": "company2-center.png",
    "characters": [
      {
        "character": "Brian",
        "position": {
          "x": 50,
          "y": 15,
          "z": 1.2
        },
        "opacity": 0
      }
    ],
    "audio": {
      "filename": "7.3-2.mp3",
      "startTime": 1,
      "startTimestamp": 17.5,
      "finishTimestamp": 24.94
    }
  },
  "commands": [
    {
      "character": "Brian",
      "opacity": 1,
      "startTime": 0
    },
    {
      "character": "Brian",
      "startTime": 1,
      "finishTime": 4.54,
      "dialogue": {
        "text": "Next, you should examine the function's description in the documentation.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "startTime": 4.84,
      "finishTime": 8.44,
      "dialogue": {
        "text": "It can explain what the function does and provide usage examples.",
        "align": "center"
      }
    },
    {
      "character": "Brian",
      "opacity": 0,
      "startTime": 8.94
    }
  ]
}