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

docs: update python helpers docs #184

Merged
merged 4 commits into from
Apr 19, 2024
Merged

Conversation

Dario-DC
Copy link
Contributor

@Dario-DC Dario-DC commented Apr 2, 2024

Checklist:

Closes #XXXXX

@Dario-DC Dario-DC requested a review from ilenia-magoni April 17, 2024 16:38
@Dario-DC Dario-DC marked this pull request as ready for review April 18, 2024 12:40
@Dario-DC Dario-DC requested a review from a team as a code owner April 18, 2024 12:40
@zairahira zairahira self-requested a review April 18, 2024 13:59
explorer.find_imports()[1].is_equivalent("from math import factorial as f")
```

#### `find_comps`
Copy link
Member

Choose a reason for hiding this comment

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

Would be helpful to tell what is comps referring to.

Choose a reason for hiding this comment

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

and a sort of lexicon about the various parts of a comprehension

Copy link

@ilenia-magoni ilenia-magoni left a comment

Choose a reason for hiding this comment

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

these will be useful, thank you!

@@ -439,6 +620,12 @@ Node("x = 1").has_variable("x") # True
Node("def foo():\n pass").has_function("foo") # True
```

#### `has_stmt`

Choose a reason for hiding this comment

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

what is stmt? can you add a word that can be found with Ctrl+F if needed?

explorer.find_function("foo").has_return("True") # True
explorer.find_function("foo").find_ifs()[0].has_return("False") # True
```

#### `has_returns`

Choose a reason for hiding this comment

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

can this have some words about how it is about return types?

explorer.find_imports()[1].is_equivalent("from math import factorial as f")
```

#### `find_comps`

Choose a reason for hiding this comment

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

and a sort of lexicon about the various parts of a comprehension

Copy link

@ilenia-magoni ilenia-magoni left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Member

@zairahira zairahira left a comment

Choose a reason for hiding this comment

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

These are quite helpful, thank you for working on these @Dario-DC 🎉

@zairahira zairahira merged commit ce4f889 into freeCodeCamp:main Apr 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants