fix(curriculum): description improvement case converter program #54051

larymak · 2024-03-11T21:10:01Z

Checklist:

I have read and followed the contribution guidelines.
I have read and followed the how to open a pull request guide.
My pull request targets the main branch of freeCodeCamp.
I have tested these changes either locally on my machine, or GitPod.

Also Closes: #54232

...on/learn-list-comprehension-by-building-a-case-converter-program/657e928716b77b2277980276.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657ee28cefc4945568287673.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efa642593c5746acc5c81.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f01ae9aea647b27402d3e.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f025ec86c3d7c4177b6be.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

zairahira · 2024-03-25T09:31:30Z

The changes are good to go from my end. 🎉

moT01 · 2024-03-26T03:50:11Z

If this is ready, you can take it out of draft mode @larymak. There should be a button below that says "ready for review" you can click.

This reverts commit c6396b8.

…CodeCamp/freeCodeCamp into feat/case-converter-program

...on/learn-list-comprehension-by-building-a-case-converter-program/657f01ae9aea647b27402d3e.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efa642593c5746acc5c81.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657ee28cefc4945568287673.md

Supravisor

In step 12

To display the output, enclose the fucntion call within the print() function.

Replace fucntion with function.

...on/learn-list-comprehension-by-building-a-case-converter-program/657e928716b77b2277980276.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657ed53c19461d4b95c4757a.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657ee28cefc4945568287673.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efce98e958b75df86b305.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f01ae9aea647b27402d3e.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f43d341a0dd17120cdb08.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f456223b8c1187b461987.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

…e-converter-program

Dario-DC

Partially reviewed. GitHub does not like me today. I'll try to finish later today.

...on/learn-list-comprehension-by-building-a-case-converter-program/657e928716b77b2277980276.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657ed53c19461d4b95c4757a.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efce98e958b75df86b305.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efdcf7fe23b76c0cff9ec.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f0044be09db790b1eb1c5.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md

zairahira

LGTM 🎉

Dario-DC

I think some important changes are required to clarify how to work with list comprehensions:

step 17
I'd leave the snake_cased_char_list list empty for this step. Let's add the
return ''.join(snake_cased_char_list).strip('_') here to add interactivity, so the campers can actually see what happens.
step 18
snake_cased_char_list becomes
['_' + char.lower() for char in pascal_or_camel_cased_string]
step 19
snake_cased_char_list = ['_' + char.lower() for char in pascal_or_camel_cased_string if char.isupper()]
step 20
snake_cased_char_list = [ '_' + char.lower() if char.isupper() else char for char in pascal_or_camel_cased_string ]

In this way:

we add a bit of interactivity
we write comprehensions that work in each step
we teach the difference between having an if and an if/else (which is quite annoying)

...on/learn-list-comprehension-by-building-a-case-converter-program/657ee28cefc4945568287673.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657efa642593c5746acc5c81.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f0044be09db790b1eb1c5.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f0353c9523d7d896873ea.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f43d341a0dd17120cdb08.md

larymak · 2024-04-26T06:32:59Z

I think some important changes are required to clarify how to work with list comprehensions:

step 17
I'd leave the snake_cased_char_list list empty for this step. Let's add the
return ''.join(snake_cased_char_list).strip('_') here to add interactivity, so the campers can actually see what happens.

step 18
snake_cased_char_list becomes
['_' + char.lower() for char in pascal_or_camel_cased_string]

step 19
snake_cased_char_list = ['_' + char.lower() for char in pascal_or_camel_cased_string if char.isupper()]

step 20
snake_cased_char_list = [ '_' + char.lower() if char.isupper() else char for char in pascal_or_camel_cased_string ]

In this way:

we add a bit of interactivity

we write comprehensions that work in each step

we teach the difference between having an if and an if/else (which is quite annoying)

Need more clarity on this

Dario-DC · 2024-04-26T08:11:34Z

Need more clarity on this

We should change the following step:

step 17
Ask the camper to add return ''.join(snake_cased_char_list).strip('_') so in the following steps we can see something that is not None printed on the screen.

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string

    snake_cased_char_list = [ ]
--fcc-editable-region--

--fcc-editable-region--
def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 18
Go back to the snake_cased_char_list list. Teach how a basic list comprehension works and ask the campers to turn the empty list into ['_' + char.lower() for char in pascal_or_camel_cased_string].

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = [ ]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 19
Now the output is wrong because we are doing the same thing for every character. Teach how to add an if to the comprehension and ask the camper do it. At the end of this step we should have
snake_cased_char_list = ['_' + char.lower() for char in pascal_or_camel_cased_string if char.isupper()]

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = ['_' + char.lower()  for char in pascal_or_camel_cased_string]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 20
The output is still wrong because now the comprehension is doing something only with uppercase characters. Teach how to write if/else inside the comprehension. At the end of this step we should have
snake_cased_char_list = [ '_' + char.lower() if char.isupper() else char for char in pascal_or_camel_cased_string ]

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = ['_' + char.lower()  for char in pascal_or_camel_cased_string if char.isupper()]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 21 and 22 remain the same

larymak · 2024-05-01T08:51:18Z

Need more clarity on this

We should change the following step:

step 17
Ask the camper to add return ''.join(snake_cased_char_list).strip('_') so in the following steps we can see something that is not None printed on the screen.

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string

    snake_cased_char_list = [ ]
--fcc-editable-region--

--fcc-editable-region--
def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 18
Go back to the snake_cased_char_list list. Teach how a basic list comprehension works and ask the campers to turn the empty list into ['_' + char.lower() for char in pascal_or_camel_cased_string].

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = [ ]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 19
Now the output is wrong because we are doing the same thing for every character. Teach how to add an if to the comprehension and ask the camper do it. At the end of this step we should have
snake_cased_char_list = ['_' + char.lower() for char in pascal_or_camel_cased_string if char.isupper()]

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = ['_' + char.lower()  for char in pascal_or_camel_cased_string]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 20
The output is still wrong because now the comprehension is doing something only with uppercase characters. Teach how to write if/else inside the comprehension. At the end of this step we should have
snake_cased_char_list = [ '_' + char.lower() if char.isupper() else char for char in pascal_or_camel_cased_string ]

seed code

def convert_to_snake_case(pascal_or_camel_cased_string):
    # snake_cased_char_list = []
    # for char in pascal_or_camel_cased_string:
    #     if char.isupper():
    #       converted_character = '_' + char.lower()
    #       snake_cased_char_list.append(converted_character)
    #     else:
    #         snake_cased_char_list.append(char)
    # snake_cased_string = ''.join(snake_cased_char_list)
    # clean_snake_cased_string = snake_cased_string.strip('_')

    # return clean_snake_cased_string
--fcc-editable-region--
    snake_cased_char_list = ['_' + char.lower()  for char in pascal_or_camel_cased_string if char.isupper()]
--fcc-editable-region--
    return ''.join(snake_cased_char_list).strip('_')

def main():
    print(convert_to_snake_case('aLongAndComplexString'))

if __name__ == '__main__':
    main()

step 21 and 22 remain the same

Changes incorporated, share feedback

ilenia-magoni

I think there should be some improvements

...on/learn-list-comprehension-by-building-a-case-converter-program/657f43d341a0dd17120cdb08.md

ilenia-magoni · 2024-05-01T09:39:41Z

...on/learn-list-comprehension-by-building-a-case-converter-program/657f43d341a0dd17120cdb08.md

 const transformedCode = code.replace(/\r/g, "");
 const convert_to_snake_case = __helpers.python.getDef("\n" + transformedCode, "convert_to_snake_case");
 const { function_body } = convert_to_snake_case;

-assert.match(function_body, / +snake_cased_char_list\s*=\s*\[\s*("|')_\1\s*\+\s*char\.lower\(\s*\)\s+if\s+char\.isupper\(\s*\)\s*\]/);
+assert.match(function_body, /return\s*''\.join\(snake_cased_char_list\)\.strip\('_'\)/);


Let's use AST tests when we are creating new ones, it allows any equivalent code, irrespective of spaces and quotes used and stuff.

Suggested change

const transformedCode = code.replace(/\r/g, "");

const convert_to_snake_case = __helpers.python.getDef("\n" + transformedCode, "convert_to_snake_case");

const { function_body } = convert_to_snake_case;

assert.match(function_body, / +snake_cased_char_list\s*=\s*\[\s*("|')_\1\s*\+\s*char\.lower\(\s*\)\s+if\s+char\.isupper\(\s*\)\s*\]/);

assert.match(function_body, /return\s*''\.join\(snake_cased_char_list\)\.strip\('_'\)/);

({

test: () => assert(runPython(`

_Node(_code).find_function('convert_to_snake_case').find_return().is_equivalent('return "".join(snake_cased_char_list).strip('_'))

`))

})

...on/learn-list-comprehension-by-building-a-case-converter-program/657f456223b8c1187b461987.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f47b12c51e41b3149e584.md

ilenia-magoni · 2024-05-01T15:53:56Z

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

+const transformedCode = code.replace(/\r/g, "");
+const convert_to_snake_case = __helpers.python.getDef("\n" + transformedCode, "convert_to_snake_case");
+const { function_body } = convert_to_snake_case;

- assert.match(function_body, / +snake_cased_char_list\s*=\s*\[\s*'_'\s*\+\s*char\.lower\(\s*\)\s+if\s+char\.isupper\(\s*\)\s*else\s*char\s*for\s+char\s+in\s+pascal_or_camel_cased_string\s*\]/);
- }
-})
+assert.match(function_body, /if\s*char\.isupper\(\)/);


This test passes on the seed code.

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

Dario-DC

I wasn't able to leave suggestions in some steps, so I left simple comments.

Some example of list comprehension syntax are required. I wrote the first examples that came to my mind but we can write something more meaningful.

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f0044be09db790b1eb1c5.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f43d341a0dd17120cdb08.md

...on/learn-list-comprehension-by-building-a-case-converter-program/657f456223b8c1187b461987.md

Dario-DC · 2024-05-01T15:29:45Z

...on/learn-list-comprehension-by-building-a-case-converter-program/657f465f8e718b19c5105ae5.md

@@ -7,26 +7,22 @@ dashedName: step-19

 # --description--



--description--

List comprehensions accept conditional statements, to evaluate the provided expression only if certain condition are met:

spam = [i * 2 for i in iterable if i > 0]

As you can see from the output, the list of characters generated from pascal_or_camel_cased_string has been joined. Since the expression inside the list comprehension is evaluated for each character, the result is a lowercase string with all the characters separated by an underscore.

Follow the example above to add an if clause to your list comprehension so that the expression is executed only if the character is uppercase.

--hints--

You should add and if clause with the condition char.isupper() to your list comprehension.

({ test: () => assert(runPython(` ifs = _Node(_code).find_function("convert_to_snake_case").find_variable("snake_cased_char_list").find_comp_ifs() len(ifs) == 1 and ifs[0].is_equivalent("char.isupper()") `)) })

We can consider to add another test to check the existing part of the comprehension.

...on/learn-list-comprehension-by-building-a-case-converter-program/657f47b12c51e41b3149e584.md

description improvement

d35ce8d

github-actions bot added the scope: curriculum Lessons, Challenges, Projects and other Curricular Content in curriculum directory. label Mar 11, 2024

ilenia-magoni requested review from fhsinchy, Dario-DC, ilenia-magoni and zairahira March 12, 2024 10:11

zairahira requested changes Mar 18, 2024

View reviewed changes

larymak and others added 2 commits March 22, 2024 17:23

Merge branch 'freeCodeCamp:main' into feat/case-converter-program

60dce15

suggestion resolved

873b86b

larymak requested a review from zairahira March 25, 2024 07:35

zairahira added the status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. label Mar 25, 2024

larymak marked this pull request as ready for review March 26, 2024 05:12

larymak added 2 commits March 28, 2024 09:19

case converter description improvement

c6396b8

description improvement

b7e83da

larymak mentioned this pull request Mar 28, 2024

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

Closed

larymak added 2 commits March 28, 2024 12:38

Revert "case converter description improvement"

b7aefe4

This reverts commit c6396b8.

Merge branch 'feat/case-converter-program' of https://github.com/free…

c64f2a0

…CodeCamp/freeCodeCamp into feat/case-converter-program

larymak force-pushed the feat/case-converter-program branch 3 times, most recently from c6396b8 to 873b86b Compare March 28, 2024 09:58

zairahira requested changes Mar 28, 2024

View reviewed changes

case converter suggestion implemetation

4980daf

Supravisor reviewed Mar 31, 2024

View reviewed changes

larymak and others added 2 commits April 3, 2024 11:34

case converter description improvement

aec1314

Merge branch 'main' into feat/case-converter-program

514c747

ilenia-magoni requested changes Apr 3, 2024

View reviewed changes

zairahira added new python course and removed status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. labels Apr 8, 2024

larymak and others added 2 commits April 9, 2024 15:01

case converter suggestion improvement

531d952

Merge branch 'freeCodeCamp:feat/case-converter-program' into feat/cas…

f0b6ab9

…e-converter-program

Dario-DC requested changes Apr 9, 2024

View reviewed changes

case converter suggestion implementation

059e182

zairahira added status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. and removed status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP labels Apr 16, 2024

zairahira reviewed Apr 16, 2024

View reviewed changes

...on/learn-list-comprehension-by-building-a-case-converter-program/657effaa2a5e0277d71f9cbe.md Outdated Show resolved Hide resolved

Sembauke added status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP and removed status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. labels Apr 16, 2024

case converter suggestion implementation

065c9cb

zairahira approved these changes Apr 19, 2024

View reviewed changes

zairahira requested review from ilenia-magoni and Dario-DC April 19, 2024 11:31

zairahira added status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. and removed status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP labels Apr 21, 2024

Dario-DC requested changes Apr 22, 2024

View reviewed changes

naomi-lgbt added status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP and removed status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. labels Apr 25, 2024

case converter suggestion implementation

ca43574

case converter suggestion implementation

60f975b

zairahira requested a review from Dario-DC May 1, 2024 11:34

zairahira added status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. and removed status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP labels May 1, 2024

ilenia-magoni requested changes May 1, 2024

View reviewed changes

Dario-DC requested changes May 1, 2024

View reviewed changes

zairahira added status: waiting update To be applied to PR if a maintainer/reviewer has left a feedback and follow up is needed from OP and removed status: waiting review To be applied to PR's that are ready for QA, especially when additional review is pending. labels May 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(curriculum): description improvement case converter program #54051

fix(curriculum): description improvement case converter program #54051

larymak commented Mar 11, 2024 •

edited

zairahira commented Mar 25, 2024

moT01 commented Mar 26, 2024

Supravisor left a comment •

edited

Dario-DC left a comment

zairahira left a comment

Dario-DC left a comment

larymak commented Apr 26, 2024

Dario-DC commented Apr 26, 2024

larymak commented May 1, 2024

ilenia-magoni left a comment

ilenia-magoni May 1, 2024

ilenia-magoni May 1, 2024

Dario-DC left a comment

Dario-DC May 1, 2024

Dario-DC May 1, 2024

fix(curriculum): description improvement case converter program #54051

Are you sure you want to change the base?

fix(curriculum): description improvement case converter program #54051

Conversation

larymak commented Mar 11, 2024 • edited

zairahira commented Mar 25, 2024

moT01 commented Mar 26, 2024

Supravisor left a comment • edited

Choose a reason for hiding this comment

Dario-DC left a comment

Choose a reason for hiding this comment

zairahira left a comment

Choose a reason for hiding this comment

Dario-DC left a comment

Choose a reason for hiding this comment

larymak commented Apr 26, 2024

Dario-DC commented Apr 26, 2024

larymak commented May 1, 2024

ilenia-magoni left a comment

Choose a reason for hiding this comment

ilenia-magoni May 1, 2024

Choose a reason for hiding this comment

ilenia-magoni May 1, 2024

Choose a reason for hiding this comment

Dario-DC left a comment

Choose a reason for hiding this comment

Dario-DC May 1, 2024

Choose a reason for hiding this comment

--description--

--hints--

Dario-DC May 1, 2024

Choose a reason for hiding this comment

larymak commented Mar 11, 2024 •

edited

Supravisor left a comment •

edited