Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

05-lists.md: Added missing explanation bit. #831

Merged
merged 2 commits into from
Jun 29, 2020
Merged

05-lists.md: Added missing explanation bit. #831

merged 2 commits into from
Jun 29, 2020

Conversation

Fnyasimi
Copy link
Contributor

I have come across missing information in this line
Use the step size argument to create a new string that contains only every other character in the string “In an octopus’s garden in the shade”

In the new correction I have added an the explanation to guide the learner in on what to do to get the desired output.

New sentence
Use the step size argument to create a new string that contains only every other second character in the string “In an octopus’s garden in the shade”

Copy link
Contributor

@ldko ldko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @Fnyasimi , thank you for taking the time to bring up the possibility of confusion in this exercise.

@@ -441,7 +441,7 @@ last: 4
> {: .output}
>
> Use the step size argument to create a new string
> that contains only every other character in the string
> that contains only every other second character in the string
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For me, the original explanation is more clear than with the addition of the word second because when I read every other second character I think perhaps it would be asking for the second character, fourth character, sixth character, etc. instead of the first, third, fifth, etc. that the expected output shows with I notpssgre ntesae. Perhaps if you and others find the exercise explanation "every other character in the string" to be unclear, we could work on making it more clear that the output should look like I notpssgre ntesae by retaining the first character, third character, fifth character...in some further way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ldko for the review feedback I think the second explanation of making it clear how the output should look like will be more understandable to me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fnyasimi, would you like to modify this PR to do that or would you like me to commit a suggestion on your branch and you can see what you think?

I am thinking the text could change to something like:

> Similarly, we can take non-continuous slices of strings.
> Use the step size argument to create a new string
> that contains only every other character in the string
> "In an octopus's garden in the shade". Start with
> creating a variable to hold the string:
>
> ~~~
> beatles = "In an octopus's garden in the shade"
> ~~~
> {: .language-python}
>
> What slice of `beatles` will produce the
> following output (i.e., the first character, third
> character, and every other character through the end
> of the string)?
> ~~~
> I notpssgre ntesae
> ~~~
> {: .output}

Do you think this text makes the exercise more clear?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ldko This is more clear and understandable of what is expected to be done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you like to make these changes to the explanation in another commit @Fnyasimi ?

@Fnyasimi
Copy link
Contributor Author

@ldko Kindly review the new changes I have made.

Copy link
Contributor

@ldko ldko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That works for me. Thank you for making the change @Fnyasimi ! 👍

Copy link
Contributor

@maxim-belkin maxim-belkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks great! Thanks, @Fnyasimi!

@maxim-belkin maxim-belkin added the type:clarification Suggest change for make lesson clearer label Jun 29, 2020
@ldko ldko merged commit a662095 into swcarpentry:gh-pages Jun 29, 2020
@ldko ldko changed the title Added missing explanation bit. 05-lists.md: Added missing explanation bit. Jun 29, 2020
zkamvar pushed a commit that referenced this pull request Apr 21, 2023
* Added missing explanation.

* Update to make the question clear
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:clarification Suggest change for make lesson clearer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants