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

Unclear instruction: Learn String Manipulation by Building a Cypher Step 3 #54234

Closed
samGreer opened this issue Mar 27, 2024 · 6 comments · Fixed by #54267
Closed

Unclear instruction: Learn String Manipulation by Building a Cypher Step 3 #54234

samGreer opened this issue Mar 27, 2024 · 6 comments · Fixed by #54267
Labels
help wanted Open for all. You do not need permission to work on these. new python course scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. type: bug Issues that need priority attention. Platform, Curriculum tests (if broken completely), etc.

Comments

@samGreer
Copy link
Contributor

Describe the Issue

The second paragraph of the instructions (shown below) uses parentheses twice.
Screenshot 2024-03-27 at 13 27 32
Given that this is a lesson about the syntax for how to call a function, I think the use of parentheses is confusing

Affected Page

https://www.freecodecamp.org/learn/scientific-computing-with-python/learn-string-manipulation-by-building-a-cipher/step-3

Your code

N/A (not a coding issue)

Expected behavior

N/A (not a coding issue)

Screenshots

No response

System

  • Device: [MacBook Air]
  • OS: [macOS]
  • Browser: [Firefox]
  • Version: [123.0]

Additional context

No response

@samGreer samGreer added scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. status: waiting triage This issue needs help from moderators and users to reproduce and confirm its validity and fix. type: bug Issues that need priority attention. Platform, Curriculum tests (if broken completely), etc. labels Mar 27, 2024
@zairahira
Copy link
Member

Hi @samGreer I do not see the word "parentheses" used twice, I hope I understood the issue correctly.
Also, what would you suggest the updated instruction to be?

@Dario-DC
Copy link
Contributor

If I understood correctly you mean the parentheses in print(), right? @samGreer

@Rabberpoli
Copy link
Contributor

The only parentheses I can see on second paragraph are the following:

  • ... call (run)
  • ... call (invoke)

If I understood correctly, right? @samGreer

If so, these are just used syntactically, so they should be ignored

@samGreer
Copy link
Contributor Author

Hi @zairahira, thanks for the questions. By "parentheses", I mean the symbols "(" and ")", not the word. Apologies for the confusion.

My proposed solution would be rewriting the second paragraph as follows:

Functions are reusable code blocks that you can call/run/invoke when you need them. To call a function, you just need to write a pair of parentheses next to its name. You will learn more about functions very soon.

My issue with the previous was that the use of parentheses in the paragraph previously indicated to me examples of syntax, while not actually being examples of syntax. I think this rewriting clears up that confusion, and means that parentheses are used in this step during examples of function calls, which I think reads clearer

@Dario-DC
Copy link
Contributor

Dario-DC commented Apr 1, 2024

Okay, I had missed the first sentence of your post @samGreer .

I would go with:

Functions are reusable code blocks that you can call, or invoke, to run their code when you need them. To call a function, you just need to write a pair of parentheses next to its name. You will learn more about functions very soon.

@zairahira
Copy link
Member

Okay, I had missed the first sentence of your post @samGreer .

I would go with:

Functions are reusable code blocks that you can call, or invoke, to run their code when you need them. To call a function, you just need to write a pair of parentheses next to its name. You will learn more about functions very soon.

Thanks for the clearification @samGreer 👍️
I'd suggest we go with this modified instruction.

@Dario-DC Dario-DC added help wanted Open for all. You do not need permission to work on these. and removed status: waiting triage This issue needs help from moderators and users to reproduce and confirm its validity and fix. labels Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Open for all. You do not need permission to work on these. new python course scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. type: bug Issues that need priority attention. Platform, Curriculum tests (if broken completely), etc.
Projects
None yet
5 participants