Back to Freecodecamp

Task 14

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

latest1.9 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--

Usage examples show how something is used.

--fillInTheBlank--

--sentence--

Next, you should BLANK the function's description in the documentation. It can BLANK what the function does and BLANK BLANK examples.

--blanks--

examine

--feedback--

It means to look at something carefully. Brian suggests looking closely at the function's description.


explain

--feedback--

It means to make something clear.


provide

--feedback--

It means to give or supply. The documentation gives examples of how to use the function.


usage

--feedback--

These examples show how to use something, like the function in this context.

--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
    }
  ]
}