From d7a1b7583404206c30e527835c464f16fdce86ef Mon Sep 17 00:00:00 2001 From: miyaliu Date: Sun, 24 Mar 2024 18:59:47 +0800 Subject: [PATCH 1/7] create tasks for dialogue 1 --- .../meta.json | 64 ++++++++++++- ...eholder.md => 65fd595245455d0dca3434ba.md} | 7 +- .../65fd5a9680a9540e9787dec5.md | 43 +++++++++ .../65fd5c89285ea50f25bd0241.md | 53 +++++++++++ .../65fd5d1a6cb7f10f77a06163.md | 47 ++++++++++ .../65fd5da902959d0fda781aa3.md | 42 +++++++++ .../65fd5dfc174596101eae1107.md | 53 +++++++++++ .../65fd5f2abfdbc510942d76f8.md | 53 +++++++++++ .../65fd5f86457b4910e35b51c9.md | 37 ++++++++ .../65fd620e9ba99c116c42c361.md | 50 ++++++++++ .../65fd63be9afd7611d2a9b788.md | 52 +++++++++++ .../65ffa914bc44081a196fa6f7.md | 50 ++++++++++ .../65ffa9d80e7ffb1ab9b4df1c.md | 53 +++++++++++ .../65fff2b49779301d9bdab6fa.md | 53 +++++++++++ .../65fff336d7553c1df86f7968.md | 54 +++++++++++ .../65fff428290eaa1e5819c119.md | 39 ++++++++ .../65fff57ce568cf1ed9702fbf.md | 92 +++++++++++++++++++ 17 files changed, 836 insertions(+), 6 deletions(-) rename curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/{dialogue-placeholder.md => 65fd595245455d0dca3434ba.md} (55%) create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5a9680a9540e9787dec5.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5da902959d0fda781aa3.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd620e9ba99c116c42c361.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd63be9afd7611d2a9b788.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa914bc44081a196fa6f7.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff428290eaa1e5819c119.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md diff --git a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json index 7a254e0afa0a23..61feffc5560547 100644 --- a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json +++ b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json @@ -10,8 +10,68 @@ "isBeta": true, "challengeOrder": [ { - "id": "655c1715102daf9d3d0d3330", - "title": "Dialogue: Placeholder" + "id": "65fd595245455d0dca3434ba", + "title": "Dialogue 1: Navigating Documentation" + }, + { + "id": "65fd5a9680a9540e9787dec5", + "title": "Task 1" + }, + { + "id": "65fd5c89285ea50f25bd0241", + "title": "Task 2" + }, + { + "id": "65fd5d1a6cb7f10f77a06163", + "title": "Task 3" + }, + { + "id": "65fd5da902959d0fda781aa3", + "title": "Task 4" + }, + { + "id": "65fd5dfc174596101eae1107", + "title": "Task 5" + }, + { + "id": "65fd5f2abfdbc510942d76f8", + "title": "Task 6" + }, + { + "id": "65fd5f86457b4910e35b51c9", + "title": "Task 7" + }, + { + "id": "65fd620e9ba99c116c42c361", + "title": "Task 8" + }, + { + "id": "65fd63be9afd7611d2a9b788", + "title": "Task 9" + }, + { + "id": "65ffa914bc44081a196fa6f7", + "title": "Task 10" + }, + { + "id": "65ffa9d80e7ffb1ab9b4df1c", + "title": "Task 11" + }, + { + "id": "65fff2b49779301d9bdab6fa", + "title": "Task 12" + }, + { + "id": "65fff336d7553c1df86f7968", + "title": "Task 13" + }, + { + "id": "65fff428290eaa1e5819c119", + "title": "Task 14" + }, + { + "id": "65fff57ce568cf1ed9702fbf", + "title": "Task 15" } ], "helpCategory": "English" diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/dialogue-placeholder.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd595245455d0dca3434ba.md similarity index 55% rename from curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/dialogue-placeholder.md rename to curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd595245455d0dca3434ba.md index de300f3817e143..2bea1b524474c0 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/dialogue-placeholder.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd595245455d0dca3434ba.md @@ -1,9 +1,8 @@ --- -id: 655c1715102daf9d3d0d3330 -title: "Dialogue: Placeholder" +id: 65fd595245455d0dca3434ba +title: "Dialogue 1: Navigating Documentation" challengeType: 21 -videoId: nLDychdBwUg -dashedName: dialogue-placeholder +dashedName: dialogue-1-navigating-documentation --- # --description-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5a9680a9540e9787dec5.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5a9680a9540e9787dec5.md new file mode 100644 index 00000000000000..c32d26f1f325dd --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5a9680a9540e9787dec5.md @@ -0,0 +1,43 @@ +--- +id: 65fd5a9680a9540e9787dec5 +title: Task 1 +challengeType: 22 +dashedName: task-1 +--- + + + +# --description-- + +`Overwhelming` means feeling like something is too much to handle. + +For example, `The amount of information was overwhelming.` (meaning it was a lot!) + +`Effective` is an adjective that describes something producing a desired result. Like, `An effective method`. + +`Effectively` is an adverb, meaning in an `effective` way. For instance, `He completed the task effectively.` + +# --fillInTheBlank-- + +## --sentence-- + +`I'm trying to understand the code documentation, but it's quite _. What should I do to navigate it more _?` + +## --blanks-- + +`overwhelming` + +### --feedback-- + +This word describes a situation where something feels too difficult or too much to handle. + +--- + +`effectively` + +### --feedback-- + +This word means in a way that is successful and achieves what you want. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md new file mode 100644 index 00000000000000..fbca677112c3d1 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md @@ -0,0 +1,53 @@ +--- +id: 65fd5c89285ea50f25bd0241 +title: Task 2 +challengeType: 19 +dashedName: task-2 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +What is Tom's main concern and what is he asking for? + +## --answers-- + +He finds the code documentation overwhelming and is asking for ways to navigate it more effectively. + +--- + +Tom wants to rewrite the code documentation. + +### --feedback-- + +Tom's concern is about understanding the existing documentation, not about rewriting it. + +--- + +He is asking for help to reduce the amount of documentation. + +### --feedback-- + +Tom's issue is not with the quantity of the documentation but with how to understand it more effectively. + +--- + +Tom is looking for someone to explain the entire documentation to him. + +### --feedback-- + +While Tom is seeking help, he specifically asks for ways to navigate the documentation more effectively, not for a full explanation. + +## --video-solution-- + +1 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md new file mode 100644 index 00000000000000..d411aff4d8944b --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md @@ -0,0 +1,47 @@ +--- +id: 65fd5d1a6cb7f10f77a06163 +title: Task 3 +challengeType: 22 +dashedName: task-3 +--- + + + +# --description-- + +`To be faced with` means to encounter or confront something, usually a challenge. For example, `She was faced with a difficult decision` meaning being in a situation where she needs to deal with something. + +A `table of contents` is a list at the beginning of a document, showing its structure. Like in a book, `The table of contents lists all the chapters.` + +# --fillInTheBlank-- + +## --sentence-- + +`Don't _, When you're _ with extensive documentation, the first thing you should do is check for a _ of contents or an index.` + +## --blanks-- + +`worry` + +### --feedback-- + +It means to feel anxious or concerned. Sarah is telling Tom not to feel overwhelmed. + +--- + +`faced` + +### --feedback-- + +It means encountering or dealing with something, often a problem or challenge. + +--- + +`table` + +### --feedback-- + +This word in this context is part of `table of contents`, which helps navigate a document by listing its main parts. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5da902959d0fda781aa3.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5da902959d0fda781aa3.md new file mode 100644 index 00000000000000..e81409d215c3f2 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5da902959d0fda781aa3.md @@ -0,0 +1,42 @@ +--- +id: 65fd5da902959d0fda781aa3 +title: Task 4 +challengeType: 22 +dashedName: task-4 +--- + +# --description-- + +`Extensive` means large in amount or scope. For example, `The researcher conducted an extensive study.` It conveys something vast or wide-ranging. + +An `index` is a list, usually at the end of a book or document, that tells you where to find specific information. Like, `I used the index to find the topic I was interested in.` + +# --fillInTheBlank-- + +## --sentence-- + +`When you're faced with _ documentation, the first thing you should do is _ for a table of contents or an _.` + +## --blanks-- + +`extensive` + +### --feedback-- + +This word describes something that is large or comprehensive. Sarah uses it to describe the vast amount of documentation. + +--- + +`check` + +### --feedback-- + +It means to look at something to confirm its presence or accuracy. Sarah suggests verifying if there is a table of contents or an index. + +--- + +`index` + +### --feedback-- + +It's a list in a document or book used for finding specific information. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md new file mode 100644 index 00000000000000..ebee4439afa185 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md @@ -0,0 +1,53 @@ +--- +id: 65fd5dfc174596101eae1107 +title: Task 5 +challengeType: 19 +dashedName: task-5 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +According to Sarah, what is the first thing a person should do when faced with extensive documentation? + +## --answers-- + +Start reading from the beginning without skipping any part + +### --feedback-- + +While thorough reading can be helpful, Sarah specifically suggests first checking for a table of contents or an index. + +--- + +Write a summary of the documentation + +### --feedback-- + +Sarah's advice is about finding a way to navigate the documentation, not about summarizing it. + +--- + +Create a new documentation guide + +### --feedback-- + +Sarah advises on how to navigate existing documentation, not on creating a new guide. + +--- + +Check for a table of contents or an index + +## --video-solution-- + +4 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md new file mode 100644 index 00000000000000..ecde031959b6b2 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md @@ -0,0 +1,53 @@ +--- +id: 65fd5f2abfdbc510942d76f8 +title: Task 6 +challengeType: 19 +dashedName: task-6 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +Why does Sarah suggest that the first thing Tom should do with extensive documentation is to check for a table of contents or an index? + +## --answers-- + +Because it will help him memorize the entire documentation + +### --feedback-- + +The purpose of checking the table of contents or index isn't memorization but efficient navigation. + +--- + +To help him find the specific information he needs more quickly + +--- + +Because it's a standard practice to read everything in order + +### --feedback-- + +The suggestion isn’t about reading everything in order but about finding specific information efficiently. + +--- + +To evaluate the quality of the documentation + +### --feedback-- + +The focus of Sarah's advice is on efficient navigation, not on evaluating the documentation's quality. + +## --video-solution-- + +2 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md new file mode 100644 index 00000000000000..dc35eec99d4e27 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md @@ -0,0 +1,37 @@ +--- +id: 65fd5f86457b4910e35b51c9 +title: Task 7 +challengeType: 22 +dashedName: task-7 +--- + + + +# --description-- + +Practice time! + +# --fillInTheBlank-- + +## --sentence-- + +`Okay, that _ sense. And what should I do _?` + +## --blanks-- + +`makes` + +### --feedback-- + +In this context, it's part of expressing that something is understandable or logical. + +--- + +`next` + +### --feedback-- + +It's about what should be done following the current action or step. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd620e9ba99c116c42c361.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd620e9ba99c116c42c361.md new file mode 100644 index 00000000000000..28cbcbb5239de2 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd620e9ba99c116c42c361.md @@ -0,0 +1,50 @@ +--- +id: 65fd620e9ba99c116c42c361 +title: Task 8 +challengeType: 19 +dashedName: task-8 +--- + +# --description-- + +Developers often use `once` to indicate the timing of tasks within their workflow. It means `as soon as` or `when`. + +For example, `Once you receive the client's feedback, update the project documentation.` This means that updating the documentation should begin immediately after receiving feedback, showing the sequence of actions in a project's lifecycle. + +# --question-- + +## --text-- + +What does `once` mean in the sentence `Once the client approves the design, we can proceed to development`? + +## --answers-- + +Before the client sees the design + +### --feedback-- + +`Once` implies that the next step (development) happens after the preceding action (approval) is complete, so the client should have seen the design. + +--- + +As soon as the client approves the design + +--- + +Without waiting for the client's approval + +### --feedback-- + +`Once` indicates that the subsequent action is dependent on the completion of the first, implying a wait for approval is necessary. + +--- + +Before the client approves the design + +### --feedback-- + +The use of `once` signifies that development should start only after receiving the client's approval, not before. + +## --video-solution-- + +2 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd63be9afd7611d2a9b788.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd63be9afd7611d2a9b788.md new file mode 100644 index 00000000000000..4094cc8487fe79 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd63be9afd7611d2a9b788.md @@ -0,0 +1,52 @@ +--- +id: 65fd63be9afd7611d2a9b788 +title: Task 9 +challengeType: 19 +dashedName: task-9 +--- + +# --description-- + +An `introductory` part is the beginning of a document that introduces the main topics. Example: `The introductory chapter of the book outlines the key concepts.` + +A `paragraph` is a section of writing on a particular theme. Like, `Each paragraph in the blog post focuses on a different technology trend.` + +`To cover` means to deal with or include specific content. For example, In a tech guide, `This section covers the steps to install software.` + +# --question-- + +## --text-- + +What is the purpose of an introductory paragraph in a technical document? + +## --answers-- + +To provide a conclusion to the document + +### --feedback-- + +A conclusion is the end part of a document that sums up the points made, not the beginning. The `introductory paragraph` introduces the main topics. + +--- + +To introduce the main topics the document will cover + +--- + +To list all the sources used in the document + +### --feedback-- + +Sources are the origins of information, like books or articles. While it's important, the `introductory paragraph` mainly introduces the document's main topics, not just lists sources. + +--- + +To display complex charts and graphs + +### --feedback-- + +Charts and graphs are visual tools to present data. They may appear in a document, but the purpose of `introductory paragraph` is to introduce the topics, not display data visuals. + +## --video-solution-- + +2 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa914bc44081a196fa6f7.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa914bc44081a196fa6f7.md new file mode 100644 index 00000000000000..7cae6eda07f906 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa914bc44081a196fa6f7.md @@ -0,0 +1,50 @@ +--- +id: 65ffa914bc44081a196fa6f7 +title: Task 10 +challengeType: 19 +dashedName: task-10 +--- + +# --description-- + +`To skim` means to read or look over something quickly to get the main ideas without focusing on the details. For example, `She skimmed the article to understand the general topic.` + +`To skim through` is similar, meaning to quickly go through a text or document. Like, `He skimmed through the manual to find the troubleshooting section.` + +# --question-- + +## --text-- + +Why would someone skim through a technical document? + +## --answers-- + +To understand every detail of the document + +### --feedback-- + +`Skimming` is not for understanding every detail but for quickly getting the main ideas or finding specific information. + +--- + +To quickly get the main ideas or find specific information + +--- + +To find grammatical errors + +### --feedback-- + +`Skimming` is more about understanding the overall content quickly, not for detailed error checking. + +--- + +To memorize the entire content + +### --feedback-- + +`Skimming` is for a quick overview, not for in-depth study or memorization of the content. + +## --video-solution-- + +2 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md new file mode 100644 index 00000000000000..12575368ec342e --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md @@ -0,0 +1,53 @@ +--- +id: 65ffa9d80e7ffb1ab9b4df1c +title: Task 11 +challengeType: 22 +dashedName: task-11 +--- + + + +# --description– + +Let’s practice! + +# --fillInTheBlank-- + +## --sentence-- + +`_ you've _ the section you need, you should start by reading the _ paragraphs to get an overview of what the documentation _.` + +## --blanks-- + +`Once` + +### --feedback-- + +It indicates that the action to follow happens as soon as the section is found. Capitalize this word. + +--- + +`found` + +### --feedback-- + +It's used here to mean locating or discovering the needed section in the documentation. + +--- + +`introductory` + +### --feedback-- + +This word refers to the beginning paragraphs that provide a basic understanding of the section. + +--- + +`covers` + +### --feedback-- + +It means what the documentation includes or addresses in terms of content. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md new file mode 100644 index 00000000000000..30a7eaf9efd4af --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md @@ -0,0 +1,53 @@ +--- +id: 65fff2b49779301d9bdab6fa +title: Task 12 +challengeType: 19 +dashedName: task-12 +--- + + + +# --description-- + +Let’s practice! + +# --question-- + +## --text-- + +According to Sarah, what should you do once you find the section you need in the documentation? + +## --answers-- + +Immediately start implementing the instructions + +### --feedback-- + +Sarah suggests reading the introductory paragraphs first to understand the section, not immediately implementing the instructions. + +--- + +Skip the introductory paragraphs and go to the main content + +### --feedback-- + +Sarah's advice is to start with the introductory paragraphs, not to skip them. + +--- + +Begin by reading the introductory paragraphs for an overview of the section + +--- + +Contact someone for help in understanding the section + +### --feedback-- + +While asking for help can be useful, Sarah specifically advises reading the introductory paragraphs to get an overview. + +## --video-solution-- + +3 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md new file mode 100644 index 00000000000000..d33a211e2da666 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md @@ -0,0 +1,54 @@ +--- +id: 65fff336d7553c1df86f7968 +title: Task 13 +challengeType: 19 +dashedName: task-13 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +What does Sarah recommend doing after reading the introductory paragraphs? + +## --answers-- + +Memorize every detail in the documentation + +### --feedback-- + +Sarah's suggestion is about skimming for relevance, not memorizing all details. + +--- + +Skim through and focus on the parts relevant to the current task + +--- + +Rewrite the sections that are difficult to understand + +### --feedback-- + +Sarah advises focusing on relevant parts, not rewriting difficult sections. + +--- + +Ignore the documentation and ask a colleague instead + +### --feedback-- + +Sarah recommends skimming through the document and focusing on relevant parts, not avoiding the documentation. + +## --video-solution-- + +2 + diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff428290eaa1e5819c119.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff428290eaa1e5819c119.md new file mode 100644 index 00000000000000..9a01ef72df8cdc --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff428290eaa1e5819c119.md @@ -0,0 +1,39 @@ +--- +id: 65fff428290eaa1e5819c119 +title: Task 14 +challengeType: 22 +dashedName: task-14 +--- + + + +# --description-- + +`Go over` means to review or examine something carefully. For example, `She decided to go over her notes before the exam.` It suggests a thorough look at something. + +`As you said` is a phrase used to refer back to something someone mentioned. Like, `I completed the task as you said.` + +# --fillInTheBlank-- + +## --sentence-- + +`Thanks. I'll go _ the documentation as you _.` + +## --blanks-- + +`over` + +### --feedback-- + +This word is part of a phrasal verb that means to review, examine, or study something carefully. Tom is planning to thoroughly review the documentation. + +--- + +`said` + +### --feedback-- + +It refers to something that was previously mentioned or advised by someone. Tom is acknowledging Sarah's suggested approach. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md new file mode 100644 index 00000000000000..3031fa5165cc4a --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md @@ -0,0 +1,92 @@ +--- +id: 65fff57ce568cf1ed9702fbf +title: Task 15 +challengeType: 22 +dashedName: task-15 +--- + + + +# --description-- +This is a review of the dialogue! + +# --fillInTheBlank-- + +## --sentence-- + +`Tom finds the code documentation _ and asks how to navigate it better. Sarah says not to _, and when faced with extensive documentation, to first look for a table of contents or an _. Understanding the _ paragraphs gives an overview of what it _. Then, Tom can _ through to focus on the _ parts for his task. In the end, Tom thanks Sarah and decides to go _ the documentation as she _.` + +## --blanks-- + +`overwhelming` + +### --feedback-- + +It means something feels too much or too difficult to handle. Tom uses this word to describe his feeling towards the documentation. + +--- + +`worry` + +### --feedback-- + +It means to feel anxious or troubled. Sarah tells Tom not to feel overwhelmed. + +--- + +`index` + +### --feedback-- + +It's a list in a document or book used for finding specific information. Sarah suggests checking it for easier navigation. + +--- + +`introductory` + +### --feedback-- + +It refers to the beginning part that introduces the main content. Sarah advises reading these paragraphs first. + +--- + +`covers` + +### --feedback-- + +It means what the documentation includes or addresses in terms of content. The introductory paragraphs help understand this. + +--- + +`skim` + +### --feedback-- + +It means to read or look over something quickly. Sarah recommends skimming to find relevant information. + +--- + +`relevant` + +### --feedback-- + +It means directly relating to the topic or problem at hand. Tom should focus on the parts that are most pertinent to his task. + +--- + +`over` + +### --feedback-- + +`Go over` means to review or examine something carefully. Tom agrees to follow Sarah's advice. + +--- + +`said` + +### --feedback-- + +It's part of a phrase used by Tom to acknowledge that he will follow the advice Sarah gave him. From 07a44582b35fbade187f0af48a51c953813a4208 Mon Sep 17 00:00:00 2001 From: miyaliu Date: Sun, 24 Mar 2024 20:10:35 +0800 Subject: [PATCH 2/7] create tasks for dialogue 2 --- .../meta.json | 52 ++++++++++++ .../66000a440c2f492ddee509f9.md | 14 +++ .../66000ac46e87f52e84328b95.md | 47 ++++++++++ .../66000eeeec06b6338a5c5caf.md | 53 ++++++++++++ .../66000f74c71b623407a8394e.md | 53 ++++++++++++ .../66000fec4b5a8c348421fada.md | 39 +++++++++ .../6600107b9dffa8350e0c4ee8.md | 53 ++++++++++++ .../660011289b5237359f69c76b.md | 53 ++++++++++++ .../660011d015f7d43626524ef8.md | 39 +++++++++ .../660012a18576e836ea18fa0b.md | 53 ++++++++++++ .../660012ff748bf2375c31b591.md | 37 ++++++++ .../660013ce54713f37ecac079d.md | 53 ++++++++++++ .../6600144958b1d33857b0309f.md | 31 +++++++ .../660014d3f5b02038de6ac35c.md | 85 +++++++++++++++++++ 14 files changed, 662 insertions(+) create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000a440c2f492ddee509f9.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000ac46e87f52e84328b95.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000fec4b5a8c348421fada.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011289b5237359f69c76b.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011d015f7d43626524ef8.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012ff748bf2375c31b591.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660013ce54713f37ecac079d.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600144958b1d33857b0309f.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660014d3f5b02038de6ac35c.md diff --git a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json index 61feffc5560547..2f1bc46ee8a8fb 100644 --- a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json +++ b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json @@ -72,6 +72,58 @@ { "id": "65fff57ce568cf1ed9702fbf", "title": "Task 15" + }, + { + "id": "66000a440c2f492ddee509f9", + "title": "Dialogue 2: Understanding Function Descriptions" + }, + { + "id": "66000ac46e87f52e84328b95", + "title": "Task 16" + }, + { + "id": "66000eeeec06b6338a5c5caf", + "title": "Task 17" + }, + { + "id": "66000f74c71b623407a8394e", + "title": "Task 18" + }, + { + "id": "66000fec4b5a8c348421fada", + "title": "Task 19" + }, + { + "id": "6600107b9dffa8350e0c4ee8", + "title": "Task 20" + }, + { + "id": "660011289b5237359f69c76b", + "title": "Task 21" + }, + { + "id": "660011d015f7d43626524ef8", + "title": "Task 22" + }, + { + "id": "660012a18576e836ea18fa0b", + "title": "Task 23" + }, + { + "id": "660012ff748bf2375c31b591", + "title": "Task 24" + }, + { + "id": "660013ce54713f37ecac079d", + "title": "Task 25" + }, + { + "id": "6600144958b1d33857b0309f", + "title": "Task 26" + }, + { + "id": "660014d3f5b02038de6ac35c", + "title": "Task 27" } ], "helpCategory": "English" diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000a440c2f492ddee509f9.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000a440c2f492ddee509f9.md new file mode 100644 index 00000000000000..59691e6fd90899 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000a440c2f492ddee509f9.md @@ -0,0 +1,14 @@ +--- +id: 66000a440c2f492ddee509f9 +title: "Dialogue 2: Understanding Function Descriptions" +challengeType: 21 +dashedName: dialogue-2-understanding-function-descriptions +--- + +# --description-- + +Watch the video below to understand the context of the upcoming lessons. + +# --assignment-- + +Watch the video diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000ac46e87f52e84328b95.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000ac46e87f52e84328b95.md new file mode 100644 index 00000000000000..f305fc0bf772fe --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000ac46e87f52e84328b95.md @@ -0,0 +1,47 @@ +--- +id: 66000ac46e87f52e84328b95 +title: Task 16 +challengeType: 22 +dashedName: task-16 +--- + + + +# --description-- + +`Interpret` means trying to understand or find the meaning of something, like figuring out what a difficult word means or what someone is trying to say. For example, `He tried to interpret the instructions as best as he could.` + +`Focus` is when you pay extra attention to one specific thing, ignoring others. It's like looking through a camera and adjusting it so only one object is clear, while everything else is blurry. For example, `She decided to focus on her math homework to finish it quickly.` + +# --fillInTheBlank-- + +## --sentence-- + +`I _ find function descriptions in the documentation, but I'm not sure how to _ them. What should I _ on when reading these?` + +## --blanks-- + +`often` + +### --feedback-- + +This word is used to indicate that something happens frequently. Tom is saying he frequently comes across function descriptions. + +--- + +`interpret` + +### --feedback-- + +It means to understand or explain the meaning. Tom is unsure how to understand the function descriptions. + +--- + +`focus` + +### --feedback-- + +It means to concentrate or give special attention to something. Tom is asking what aspects to concentrate on in the function descriptions. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md new file mode 100644 index 00000000000000..3a78d4c9d852fe --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md @@ -0,0 +1,53 @@ +--- +id: 66000eeeec06b6338a5c5caf +title: Task 17 +challengeType: 19 +dashedName: task-17 +--- + + + +# --description-- + +Let’s practice! + +# --question-- + +## --text-- + +How frequently does Tom find function descriptions in the documentation? + +## --answers-- + +`Rarely` + +### --feedback-- + +`Rarely` indicates something happens not often. However, Tom uses `often`, indicating a more frequent occurrence. + +--- + +`Sometimes` + +### --feedback-- + +`Sometimes` suggests occasional occurrence, but Tom's use of `often` implies it happens more regularly than just sometimes. + +--- + +`Often` + +--- + +`Always` + +### --feedback-- + +`Always` would mean it happens every time, which is a stronger frequency than `often`. + +## --video-solution-- + +3 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md new file mode 100644 index 00000000000000..0a1480f8d771a4 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md @@ -0,0 +1,53 @@ +--- +id: 66000f74c71b623407a8394e +title: Task 18 +challengeType: 19 +dashedName: task-18 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +What is Tom's main concern in his statement? + +## --answers-- + +He is unsure where to find the function descriptions. + +### --feedback-- + +Tom mentions finding the descriptions often, so his concern isn't about locating them. + +--- + +He finds the function descriptions too complex. + +### --feedback-- + +Although he finds them complex to interpret, Tom's main concern is about how to understand or interpret them. + +--- + +He is unsure how to interpret the function descriptions. + +--- + +He wants to rewrite the function descriptions. + +### --feedback-- + +Tom's concern is about understanding the existing descriptions, not about rewriting them. + +## --video-solution-- + +3 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000fec4b5a8c348421fada.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000fec4b5a8c348421fada.md new file mode 100644 index 00000000000000..cf4969f80b21ef --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000fec4b5a8c348421fada.md @@ -0,0 +1,39 @@ +--- +id: 66000fec4b5a8c348421fada +title: Task 19 +challengeType: 22 +dashedName: task-19 +--- + + + +# --description-- + +`Pay attention` means to focus or concentrate on something. For example, `In class, it's important to pay attention to the teacher's explanation.` + +In programming, `parameters` are the special kind of variables in a function that are used to pass data or information into the function. Like, The function `calculateSum(a, b)` has two parameters: `a` and `b`. + +# --fillInTheBlank-- + +## --sentence-- + +`First, you should _ attention to the function's name and _.` + +## --blanks-- + +`pay` + +### --feedback-- + +`Pay attention` means to focus or concentrate on something. Sarah advises focusing on specific aspects of the function. + +--- + +`parameters` + +### --feedback-- + +They are values that functions use to pass data or information into the function. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md new file mode 100644 index 00000000000000..eb8d119f2bd7e5 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md @@ -0,0 +1,53 @@ +--- +id: 6600107b9dffa8350e0c4ee8 +title: Task 20 +challengeType: 19 +dashedName: task-20 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +Why does Sarah suggest that Tom should pay attention to the function's name and parameters? + +## --answers-- + +To memorize the code more easily + +### --feedback-- + +While memorization can be helpful, Sarah's advice is about understanding the function's purpose and usage, not just memorizing the code. + +--- + +To determine the complexity of the function + +### --feedback-- + +The focus of Sarah's advice is on understanding what the function does and how to use it, rather than assessing its complexity. + +--- + +To understand what the function does and how to use it + +--- + +To find errors in the function's code + +### --feedback-- + +Sarah's suggestion is aimed at understanding the function's role and usage, not primarily at finding errors. + +## --video-solution-- + +3 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011289b5237359f69c76b.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011289b5237359f69c76b.md new file mode 100644 index 00000000000000..434b06bb3a1ec9 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011289b5237359f69c76b.md @@ -0,0 +1,53 @@ +--- +id: 660011289b5237359f69c76b +title: Task 21 +challengeType: 19 +dashedName: task-21 +--- + + + +# --description-- + +This task is about understanding Tom's question. He is asking if there is more information or advice he needs to know about understanding function descriptions in documentation. + +# --question-- + +## --text-- + +What is Tom asking for in his statement? + +## --answers-- + +Tom is saying he knows everything now. + +### --feedback-- + +Tom understands what was said before, but he's asking if there is more he needs to learn. + +--- + +Tom wants to hear all the information again. + +### --feedback-- + +He's not asking to hear everything again. He's asking if there's more information he should know. + +--- + +Tom needs examples of the function descriptions. + +### --feedback-- + +Tom isn't asking for examples. He wants to know if there are other important things to learn. + +--- + +Tom is asking if there's more advice or tips he should know about. + +## --video-solution-- + +4 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011d015f7d43626524ef8.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011d015f7d43626524ef8.md new file mode 100644 index 00000000000000..fc6a7a10d70aea --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660011d015f7d43626524ef8.md @@ -0,0 +1,39 @@ +--- +id: 660011d015f7d43626524ef8 +title: Task 22 +challengeType: 22 +dashedName: task-22 +--- + + + +# --description-- + +A `description` is a detailed explanation about something. For example, `The report included a detailed description of the project.` + +A `function` in programming is a set of instructions that performs a specific task. Like, `The "calculateTotal" function adds up prices.` + +# --fillInTheBlank-- + +## --sentence-- + +`Absolutely. You should look for a _ of what the _ does and any return values.` + +## --blanks-- + +`description` + +### --feedback-- + +It refers to the detailed explanation of the function's purpose and operations. + +--- + +`function` + +### --feedback-- + +It's a specific set of instructions in programming that performs a particular task. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md new file mode 100644 index 00000000000000..cfc7d2c00d169b --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md @@ -0,0 +1,53 @@ +--- +id: 660012a18576e836ea18fa0b +title: Task 23 +challengeType: 19 +dashedName: task-23 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +What does Sarah suggest looking for in a function's description? + +## --answers-- + +Only the return values of the function + +### --feedback-- + +While return values are important, Sarah advises looking at both the function's purpose and its return values, not just the latter. + +--- + +The programming language used in the function + +### --feedback-- + +Sarah's focus is on understanding what the function does and its return values, not the programming language it's written in. + +--- + +A description of the function's purpose and any return values + +--- + +The length of time the function takes to execute + +### --feedback-- + +Sarah mentions understanding the function's purpose and return values, not the execution time of the function. + +## --video-solution-- + +3 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012ff748bf2375c31b591.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012ff748bf2375c31b591.md new file mode 100644 index 00000000000000..479a69bb139d82 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012ff748bf2375c31b591.md @@ -0,0 +1,37 @@ +--- +id: 660012ff748bf2375c31b591 +title: Task 24 +challengeType: 22 +dashedName: task-24 +--- + + + +# --description-- + +`Snippets` are small parts or pieces, especially of code. In programming, a `snippet` is a small section of reusable code. For example, `He used a snippet from the library to simplify the task.` + +# --fillInTheBlank-- + +## --sentence-- + +`Also, check for any examples or code _. They can help illustrate how to use the function _.` + +## --blanks-- + +`snippets` + +### --feedback-- + +It refers to small pieces of code that can be used as examples to understand larger concepts. + +--- + +`effectively` + +### --feedback-- + +It means in a way that is successful in producing the desired result. Here, it's about using the function in the best possible way. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660013ce54713f37ecac079d.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660013ce54713f37ecac079d.md new file mode 100644 index 00000000000000..87665c2a427e80 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660013ce54713f37ecac079d.md @@ -0,0 +1,53 @@ +--- +id: 660013ce54713f37ecac079d +title: Task 25 +challengeType: 19 +dashedName: task-25 +--- + + + +# --description-- + +This task assesses your understanding of why Sarah suggests Tom should check for examples and code snippets when reading function descriptions. Identifying the rationale behind specific advice is crucial for effective learning and application in technical fields. + +# --question-- + +## --text-- + +Why should Tom check for examples and code snippets according to Sarah? + +## --answers-- + +To help illustrate how to use the function effectively + +--- + +To determine the coding style of the documentation + +### --feedback-- + +While understanding coding style is important, Sarah's specific reason for suggesting to check examples and snippets is to illustrate how to use the function. + +--- + +To find errors in the function's code + +### --feedback-- + +Sarah recommends looking at examples and snippets for understanding usage, not necessarily for error checking. + +--- + +To rewrite the function in a different way + +### --feedback-- + +The purpose of checking examples and snippets is to learn how to use the function as it is, not to rewrite it. + +## --video-solution-- + +1 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600144958b1d33857b0309f.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600144958b1d33857b0309f.md new file mode 100644 index 00000000000000..583f7077fbfbf1 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600144958b1d33857b0309f.md @@ -0,0 +1,31 @@ +--- +id: 6600144958b1d33857b0309f +title: Task 26 +challengeType: 22 +dashedName: task-26 +--- + + + +# --description-- + +`Tips` are pieces of advice or suggestions that can help someone do something better or more easily. + +For example, `She gave me some helpful tips on how to improve my coding skills.` + +# --fillInTheBlank-- + +## --sentence-- + +`Great _. Thanks a lot.` + +## --blanks-- + +`tips` + +### --feedback-- + +It refers to the useful pieces of advice or suggestions that Sarah gave Tom to understand function descriptions better. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660014d3f5b02038de6ac35c.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660014d3f5b02038de6ac35c.md new file mode 100644 index 00000000000000..11f899bb7286cb --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660014d3f5b02038de6ac35c.md @@ -0,0 +1,85 @@ +--- +id: 660014d3f5b02038de6ac35c +title: Task 27 +challengeType: 22 +dashedName: task-27 +--- + + + +# --description-- + +This task involves summarizing the conversation between Tom and Sarah about understanding function descriptions in documentation. + +# --fillInTheBlank-- + +## --sentence-- + +`Tom _ finds function descriptions but is unsure how to _ them. Sarah advises focusing on the function's name and _. She also suggests looking for a _ of the function's purpose and any _ values. Checking for _ or code _ can help understand how to use the function. Tom acknowledges these great _ from Sarah.` + +## --blanks-- + +`often` + +### --feedback-- + +It means frequently. Tom frequently encounters function descriptions in the documentation. + +--- + +`interpret` + +### --feedback-- + +This word means to understand or explain the meaning. Tom is looking for advice on how to understand these descriptions. + +--- + +`parameters` + +### --feedback-- + +They are part of a function's definition, giving clues about what the function does. + +--- + +`description` + +### --feedback-- + +It gives details about what the function is designed to do. + +--- + +`return` + +### --feedback-- + +`Return values` are what the function gives back after processing. + +--- + +`examples` + +### --feedback-- + +They are instances or illustrations that show how something is used. + +--- + +`snippets` + +### --feedback-- + +They are small pieces of code that provide practical examples of usage. + +--- + +`tips` + +### --feedback-- + +It means useful pieces of advice that Sarah gives to Tom. From 462242424a3d88acaee3c7f16635e01f54da9a30 Mon Sep 17 00:00:00 2001 From: miyaliu Date: Sun, 24 Mar 2024 20:53:21 +0800 Subject: [PATCH 3/7] create tasks for dialogue 3 --- .../meta.json | 40 ++++++++ .../660019617debd03c767e0a3d.md | 14 +++ .../66001985c091f13cda6d4f4d.md | 53 +++++++++++ .../66001a1c9df0a83d8e8c670a.md | 53 +++++++++++ .../66001a935988e43e1183bd38.md | 45 +++++++++ .../66001b1aa59adc3ea4b024b4.md | 53 +++++++++++ .../66001b8d0518d03f18b19715.md | 37 ++++++++ .../66001be61f20a33f8a45f3cb.md | 53 +++++++++++ .../66001cac957f0740252c2611.md | 53 +++++++++++ .../66001d1ffd0e0b40a8cbf0c7.md | 47 ++++++++++ .../66001d8b878f5141214f2d77.md | 93 +++++++++++++++++++ 11 files changed, 541 insertions(+) create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660019617debd03c767e0a3d.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d1ffd0e0b40a8cbf0c7.md create mode 100644 curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md diff --git a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json index 2f1bc46ee8a8fb..9f4c7e7cd0f831 100644 --- a/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json +++ b/curriculum/challenges/_meta/learn-how-to-read-and-understand-code-documentation/meta.json @@ -124,6 +124,46 @@ { "id": "660014d3f5b02038de6ac35c", "title": "Task 27" + }, + { + "id": "660019617debd03c767e0a3d", + "title": "Dialogue 3: Understanding Parameters and Options" + }, + { + "id": "66001985c091f13cda6d4f4d", + "title": "Task 28" + }, + { + "id": "66001a1c9df0a83d8e8c670a", + "title": "Task 29" + }, + { + "id": "66001a935988e43e1183bd38", + "title": "Task 30" + }, + { + "id": "66001b1aa59adc3ea4b024b4", + "title": "Task 31" + }, + { + "id": "66001b8d0518d03f18b19715", + "title": "Task 32" + }, + { + "id": "66001be61f20a33f8a45f3cb", + "title": "Task 33" + }, + { + "id": "66001cac957f0740252c2611", + "title": "Task 34" + }, + { + "id": "66001d1ffd0e0b40a8cbf0c7", + "title": "Task 35" + }, + { + "id": "66001d8b878f5141214f2d77", + "title": "Task 36" } ], "helpCategory": "English" diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660019617debd03c767e0a3d.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660019617debd03c767e0a3d.md new file mode 100644 index 00000000000000..0f4a3ec30ad2b2 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660019617debd03c767e0a3d.md @@ -0,0 +1,14 @@ +--- +id: 660019617debd03c767e0a3d +title: "Dialogue 3: Understanding Parameters and Options" +challengeType: 21 +dashedName: dialogue-3-understanding-parameters-and-options +--- + +# --description-- + +Watch the video below to understand the context of the upcoming lessons. + +# --assignment-- + +Watch the video diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md new file mode 100644 index 00000000000000..044484e0325d92 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md @@ -0,0 +1,53 @@ +--- +id: 66001985c091f13cda6d4f4d +title: Task 28 +challengeType: 22 +dashedName: task-28 +--- + + + +# --description-- + +Practice time. + +# --fillInTheBlank-- + +## --sentence-- + +`I sometimes get _ with the _ and options _ in the documentation. What should I do to understand them _?` + +## --blanks-- + +`confused` + +### --feedback-- + +It means being unsure or not understanding something clearly. Tom is having trouble understanding parameters and options. + +--- + +`parameters` + +### --feedback-- + +They are specific settings or values that functions use. Tom is trying to grasp what these `parameters` in the documentation mean. + +--- + +`listed` + +### --feedback-- + +It refers to items being written down or included in a list, like the parameters and options in the documentation. + +--- + +`better` + +### --feedback-- + +In this context, it means to understand more clearly or effectively. Tom wants to improve his understanding of the documentation. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md new file mode 100644 index 00000000000000..24fbc9d93829e0 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md @@ -0,0 +1,53 @@ +--- +id: 66001a1c9df0a83d8e8c670a +title: Task 29 +challengeType: 19 +dashedName: task-29 +--- + + + +# --description-- + +Practice time! + +# --question-- + +## --text-- + +What does Tom want to understand better? + +## --answers-- + +The coding language used in the documentation + +### --feedback-- + +Tom's confusion is not about the coding language, but specifically about the parameters and options in the documentation. + +--- + +The parameters and options in the documentation + +--- + +How to write the documentation himself + +### --feedback-- + +Tom is not seeking to write documentation but to better understand the parameters and options listed in it. + +--- + +The entire content of the documentation + +### --feedback-- + +Tom specifically mentions his confusion about parameters and options, not the entire content of the documentation. + +## --video-solution-- + +2 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md new file mode 100644 index 00000000000000..319c7ef06eb369 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md @@ -0,0 +1,45 @@ +--- +id: 66001a935988e43e1183bd38 +title: Task 30 +challengeType: 22 +dashedName: task-30 +--- + + + +# --description-- + +Practice time. + +# --fillInTheBlank-- + +## --sentence-- + +`You should _ by reading their descriptions. The documentation can _ details on what _ parameter does and how to use it.` + +## --blanks-- + +`begin` + +### --feedback-- + +It means to start something. Sarah suggests starting by reading the descriptions of the parameters. + +--- + +`provide` + +### --feedback-- + +It means to offer information or details. The documentation gives information about the parameters. + +--- + +`each` + +### --feedback-- + +It refers to every one of the parameters, considered one by one. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md new file mode 100644 index 00000000000000..27a56e3e3697da --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md @@ -0,0 +1,53 @@ +--- +id: 66001b1aa59adc3ea4b024b4 +title: Task 31 +challengeType: 19 +dashedName: task-31 +--- + + + +# --description-- + +Practice time. + +# --question-- + +## --text-- + +How can the documentation help according to Sarah? + +## --answers-- + +By offering a step-by-step guide to write the code + +### --feedback-- + +While helpful, Sarah specifically mentions that the documentation provides details on parameters and their usage, not a step-by-step coding guide. + +--- + +By providing background information about the project + +### --feedback-- + +Sarah's focus is on explaining parameters and their usage, not on giving background information about the project. + +--- + +By giving examples of completed projects + +### --feedback-- + +Sarah doesn't mention examples of projects; she talks about details on parameters and their use. + +--- + +By providing details on what each parameter does and how to use it + +## --video-solution-- + +4 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md new file mode 100644 index 00000000000000..368f38f7729e74 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md @@ -0,0 +1,37 @@ +--- +id: 66001b8d0518d03f18b19715 +title: Task 32 +challengeType: 22 +dashedName: task-32 +--- + + + +# --description-- + +Practice time. + +# --fillInTheBlank-- + +## --sentence-- + +`I'll _ that in mind. What should I do _?` + +## --blanks-- + +`keep` + +### --feedback-- + +It means to continue to remember or consider the advice given. + +--- + +`next` + +### --feedback-- + +It's about what Tom should do after considering the current advice. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md new file mode 100644 index 00000000000000..d013d012d2ebf4 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md @@ -0,0 +1,53 @@ +--- +id: 66001be61f20a33f8a45f3cb +title: Task 33 +challengeType: 22 +dashedName: task-33 +--- + + + +# --description-- + +Practice time! + +# --fillInTheBlank-- + +## --sentence-- + +`Next, you should look for any _ that demonstrate how to use _ parameters in practice. Examples can show you how to _ options correctly and what _ they have on the code.` + +## --blanks-- + +`examples` + +### --feedback-- + +They are practical demonstrations or instances that help in understanding how to apply the parameters. + +--- + +`these` + +### --feedback-- + +It refers to the particular parameters Sarah mentioned earlier. + +--- + +`set` + +### --feedback-- + +In this context, It's about adjusting or configuring options in a certain way. + +--- + +`effect` + +### --feedback-- + +It means the outcome or result that comes from setting the options in a particular manner. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md new file mode 100644 index 00000000000000..6d664a49536ec2 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md @@ -0,0 +1,53 @@ +--- +id: 66001cac957f0740252c2611 +title: Task 34 +challengeType: 19 +dashedName: task-34 +--- + + + +# --description-- + +Practice time. + +# --question-- + +## --text-- + +According to Sarah, why are examples important? + +## --answers-- + +They show how to set options correctly and the effect they have on the code. + +--- + +They provide a history of how the code was developed. + +### --feedback-- + +Sarah emphasizes practical application, showing how to use parameters and their effects, rather than discussing the historical development of the code. + +--- + +They list all possible errors in the code. + +### --feedback-- + +Sarah highlights examples for understanding correct usage and effects, not specifically for listing potential errors. + +--- + +They offer alternative ways to write the same code. + +### --feedback-- + +The focus is on demonstrating correct use and understanding effects of parameters, not on presenting multiple coding approaches. + +## --video-solution-- + +1 diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d1ffd0e0b40a8cbf0c7.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d1ffd0e0b40a8cbf0c7.md new file mode 100644 index 00000000000000..eb1af1d34b7c89 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d1ffd0e0b40a8cbf0c7.md @@ -0,0 +1,47 @@ +--- +id: 66001d1ffd0e0b40a8cbf0c7 +title: Task 35 +challengeType: 22 +dashedName: task-35 +--- + + + +# --description-- + +To `navigate` means to find one's way around a specific area or to go through something systematically. For example, `He learned to navigate through the software with ease.` + +A `recommendation` is a piece of advice or suggestion given to guide someone's choice or decision. For example, `Based on her experience, she gave me a recommendation to try the new coding tutorial.` + +# --fillInTheBlank-- + +## --sentence-- + +`Thank you. Your _ is helping me _ this documentation better. I'll follow your _.` + +## --blanks-- + +`guidance` + +### --feedback-- + +It means help or advice. Tom is thanking Sarah for her helpful advice. + +--- + +`navigate` + +### --feedback-- + +This word means to find one's way through it. Tom is saying that Sarah's advice is helping him understand the documentation. + +--- + +`recommendations` + +### --feedback-- + +It means suggestions or advice. Tom plans to follow the advice Sarah gave him. diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md new file mode 100644 index 00000000000000..16b1197838e365 --- /dev/null +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md @@ -0,0 +1,93 @@ +--- +id: 66001d8b878f5141214f2d77 +title: Task 36 +challengeType: 22 +dashedName: task-36 +--- + + + +# --description-- + +This task involves summarizing the conversation between Tom and Sarah about understanding parameters and options in documentation. + +# --fillInTheBlank-- + +## --sentence-- + +`Tom is _ with the _ and options in the documentation and asks how to understand them better. Sarah suggests starting with reading their _. She explains that the documentation provides details on what each parameter does and its usage. She advises looking for _ that show how to _ options correctly and the _ they have. Tom thanks Sarah for her _ and says it helps him _ through the documentation. He agrees to follow her _.` + +## --blanks-- + +`confused` + +### --feedback-- + +It means not being clear about something. Tom is unclear about how to understand the parameters and options. + +--- + +`parameters` + +### --feedback-- + +THey are special settings in functions or commands. Tom needs help understanding these. + +--- + +`descriptions` + +### --feedback-- + +They provide details about something. Sarah suggests these as a starting point for understanding. + +--- + +`examples` + +### --feedback-- + +These are specific instances that illustrate how something is used. They help in showing practical application. + +--- + +`set` + +### --feedback-- + +It means to adjust or put into a specific state. It's about configuring options in code. + +--- + +`effect` + +### --feedback-- + +It refers to the result or impact of something, like what happens when options are set in a certain way. + +--- + +`guidance` + +### --feedback-- + +It's advice or help. Sarah's advice is aiding Tom in understanding the documentation. + +--- + +`navigate` + +### --feedback-- + +It means to find one's way through something. Tom finds Sarah's advice helpful in going through the documentation. + +--- + +`recommendations` + +### --feedback-- + +It means pieces of advice. Tom plans to follow the advice Sarah has given. From 715ee65b11c8329fecbf82185fef81d2b99b2b5a Mon Sep 17 00:00:00 2001 From: miyaliu Date: Tue, 7 May 2024 11:59:51 +0800 Subject: [PATCH 4/7] replace practice time --- .../65fd5c89285ea50f25bd0241.md | 2 +- .../65fd5dfc174596101eae1107.md | 2 +- .../65fd5f2abfdbc510942d76f8.md | 2 +- .../65fd5f86457b4910e35b51c9.md | 2 +- .../65ffa9d80e7ffb1ab9b4df1c.md | 2 +- .../65fff2b49779301d9bdab6fa.md | 2 +- .../65fff336d7553c1df86f7968.md | 2 +- .../65fff57ce568cf1ed9702fbf.md | 3 ++- .../66000eeeec06b6338a5c5caf.md | 2 +- .../66000f74c71b623407a8394e.md | 2 +- .../6600107b9dffa8350e0c4ee8.md | 2 +- .../660012a18576e836ea18fa0b.md | 2 +- .../66001985c091f13cda6d4f4d.md | 2 +- .../66001a1c9df0a83d8e8c670a.md | 2 +- .../66001a935988e43e1183bd38.md | 2 +- .../66001b1aa59adc3ea4b024b4.md | 2 +- .../66001b8d0518d03f18b19715.md | 2 +- .../66001be61f20a33f8a45f3cb.md | 2 +- .../66001cac957f0740252c2611.md | 2 +- 19 files changed, 20 insertions(+), 19 deletions(-) diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md index fbca677112c3d1..486c8618fbca16 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5c89285ea50f25bd0241.md @@ -12,7 +12,7 @@ Tom: I'm trying to understand the code documentation, but it's quite overwhelmin # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md index ebee4439afa185..bcecb38133c9fa 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5dfc174596101eae1107.md @@ -12,7 +12,7 @@ Sarah: Don't worry. When you're faced with extensive documentation, the first th # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md index ecde031959b6b2..a2933bc8d8eacc 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f2abfdbc510942d76f8.md @@ -12,7 +12,7 @@ Sarah: Don't worry. When you're faced with extensive documentation, the first th # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md index dc35eec99d4e27..af9144dbc90a9d 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5f86457b4910e35b51c9.md @@ -12,7 +12,7 @@ Tom: Okay, that makes sense. And what should I do next? # --description-- -Practice time! +Answer the question below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md index 12575368ec342e..ea1209ee691f7b 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65ffa9d80e7ffb1ab9b4df1c.md @@ -12,7 +12,7 @@ Sarah: Once you've found the section you need, you should start by reading the i # --description– -Let’s practice! +Fill in the blanks in the dialogue below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md index 30a7eaf9efd4af..d5275b3d89d929 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff2b49779301d9bdab6fa.md @@ -12,7 +12,7 @@ Sarah: Once you've found the section you need, you should start by reading the i # --description-- -Let’s practice! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md index d33a211e2da666..5f5e18c7f15aca 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff336d7553c1df86f7968.md @@ -12,7 +12,7 @@ Sarah: Then, you can skim through and focus on the parts relevant to your curren # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md index 3031fa5165cc4a..2997605b615fad 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fff57ce568cf1ed9702fbf.md @@ -11,7 +11,8 @@ Entire dialogue --> # --description-- -This is a review of the dialogue! + +This is a review of the dialogue. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md index 3a78d4c9d852fe..ef9fa57194695b 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000eeeec06b6338a5c5caf.md @@ -12,7 +12,7 @@ Tom: I often find function descriptions in the documentation, but I'm not sure h # --description-- -Let’s practice! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md index 0a1480f8d771a4..3215ecd8516d91 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66000f74c71b623407a8394e.md @@ -12,7 +12,7 @@ Tom: I often find function descriptions in the documentation, but I'm not sure h # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md index eb8d119f2bd7e5..b546e71ba88c3b 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/6600107b9dffa8350e0c4ee8.md @@ -12,7 +12,7 @@ Sarah: That's a great question. First, you should pay attention to the function' # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md index cfc7d2c00d169b..0af01723a4aa7f 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/660012a18576e836ea18fa0b.md @@ -12,7 +12,7 @@ Sarah: Absolutely. You should look for a description of what the function does a # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md index 044484e0325d92..9caf6bb17e6a0a 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md @@ -12,7 +12,7 @@ Tom: I sometimes get confused with the parameters and options listed in the docu # --description-- -Practice time. +Fill in the blanks in the dialogue below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md index 24fbc9d93829e0..7b3457e239bc51 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a1c9df0a83d8e8c670a.md @@ -12,7 +12,7 @@ Tom: I sometimes get confused with the parameters and options listed in the docu # --description-- -Practice time! +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md index 319c7ef06eb369..30bc71edccda56 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001a935988e43e1183bd38.md @@ -12,7 +12,7 @@ Sarah: You should begin by reading their descriptions. The documentation can pro # --description-- -Practice time. +Fill in the blanks in the dialogue below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md index 27a56e3e3697da..67591a4aac621f 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b1aa59adc3ea4b024b4.md @@ -12,7 +12,7 @@ Sarah: You should begin by reading their descriptions. The documentation can pro # --description-- -Practice time. +Answer the question below. # --question-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md index 368f38f7729e74..db611565f3c9f8 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001b8d0518d03f18b19715.md @@ -12,7 +12,7 @@ Tom: I'll keep that in mind. What should I do next? # --description-- -Practice time. +Fill in the blanks in the dialogue below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md index d013d012d2ebf4..2671282b945b06 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001be61f20a33f8a45f3cb.md @@ -12,7 +12,7 @@ Sarah: Next, you should look for any examples that demonstrate how to use these # --description-- -Practice time! +Fill in the blanks in the dialogue below. # --fillInTheBlank-- diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md index 6d664a49536ec2..e83c21ccf59256 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001cac957f0740252c2611.md @@ -12,7 +12,7 @@ Sarah: Next, you should look for any examples that demonstrate how to use these # --description-- -Practice time. +Answer the question below. # --question-- From 5b34e4dc42f7311b4af59f21955fe379f523e240 Mon Sep 17 00:00:00 2001 From: miyaliu666 Date: Thu, 9 May 2024 10:03:22 +0800 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: Tom <20648924+moT01@users.noreply.github.com> --- .../65fd5d1a6cb7f10f77a06163.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md index d411aff4d8944b..4c2e10416efed2 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/65fd5d1a6cb7f10f77a06163.md @@ -20,7 +20,7 @@ A `table of contents` is a list at the beginning of a document, showing its stru ## --sentence-- -`Don't _, When you're _ with extensive documentation, the first thing you should do is check for a _ of contents or an index.` +`Don't _. When you're _ with extensive documentation, the first thing you should do is check for a _ of contents or an index.` ## --blanks-- From 1e9d6e290c320bb0af6a9335ea6a0f44cebd8a08 Mon Sep 17 00:00:00 2001 From: miyaliu666 Date: Sun, 12 May 2024 12:38:51 +0800 Subject: [PATCH 6/7] Apply suggestions from code review Co-authored-by: Naomi --- .../66001d8b878f5141214f2d77.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md index 16b1197838e365..9af75fa2da1573 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001d8b878f5141214f2d77.md @@ -34,7 +34,7 @@ It means not being clear about something. Tom is unclear about how to understand ### --feedback-- -THey are special settings in functions or commands. Tom needs help understanding these. +They are placeholder variables in the function. --- From ecae61998db2efa8799d4731d996727abda9c895 Mon Sep 17 00:00:00 2001 From: miyaliu Date: Sun, 12 May 2024 12:49:14 +0800 Subject: [PATCH 7/7] correct the feedback for parameters in task 28 --- .../66001985c091f13cda6d4f4d.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md index 9caf6bb17e6a0a..7fb668f7081fbb 100644 --- a/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md +++ b/curriculum/challenges/english/21-a2-english-for-developers/learn-how-to-read-and-understand-code-documentation/66001985c091f13cda6d4f4d.md @@ -34,7 +34,7 @@ It means being unsure or not understanding something clearly. Tom is having trou ### --feedback-- -They are specific settings or values that functions use. Tom is trying to grasp what these `parameters` in the documentation mean. +They are placeholder variables for passing input values to the function. ---