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

🌳 Improving Trees Code #39

Open
dpshelio opened this issue Dec 2, 2024 · 6 comments
Open

🌳 Improving Trees Code #39

dpshelio opened this issue Dec 2, 2024 · 6 comments
Labels
week09 Structure and design

Comments

@dpshelio
Copy link
Contributor

dpshelio commented Dec 2, 2024

Open the repository for this exercise. You will find a brief description of each example in its README.md file.

  1. Discuss the code with your group. What problems do you see with it? Why?
  2. Write below your comments mentioning your group number. For now, focus on the
    problems, and don't make any changes yet!
@dpshelio dpshelio added the week09 Structure and design label Dec 2, 2024
@iaheung
Copy link

iaheung commented Dec 2, 2024

Group 4:

  • The calculations inside the append function can be written to a subfunction/helper function
  • It is not clear what the variables are attributed to
  • The variable names can be more explicit

@D1Vincenzo
Copy link

Group 7

  1. Add some docstrings and comments
  2. Change the variables name to be more clear
  3. Overall improve the readibility

@r4b61t
Copy link

r4b61t commented Dec 2, 2024

Group 5

  • Has 1 comment that is completely useless
  • Variables' names don't convey what it represents clearly
  • calculations should be encapsulated in a function

@azure80
Copy link

azure80 commented Dec 2, 2024

Group 1:

  • Variable names are unhelpful, make it hard to follow what is happening.
  • No indication as to what the indexing relates to
  • So specified use-case for the trees code
  • Lack comments and docstrings

@YangMM24
Copy link

YangMM24 commented Dec 2, 2024

Group 2

  • Missing comment
  • The loop structure is not encapsulated as a function
  • Variables are not clearly named
  • It might be better to use variables instead of hardcoding (e.g. 0.1)

@zcemksd
Copy link

zcemksd commented Dec 2, 2024

Group 6:

  • There are not enough comments, it's not obvious what the code is doing
  • Name variables are not clear: what are 's', 'd', 'n'?
  • The calculations could be made into a function that works outside the loop and is called in the loop to help with clarity of the code understanding

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
week09 Structure and design
Projects
None yet
Development

No branches or pull requests

7 participants