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

Confusing docstring in assignment 2 #194

Closed
BeneHTWG opened this issue Dec 6, 2024 · 2 comments · Fixed by #198
Closed

Confusing docstring in assignment 2 #194

BeneHTWG opened this issue Dec 6, 2024 · 2 comments · Fixed by #198
Assignees
Labels
assignments Assignment submissions or anything else related to the assignments documentation Improvements or additions to documentation 🏅 1 bonus point

Comments

@BeneHTWG
Copy link
Contributor

BeneHTWG commented Dec 6, 2024

  • in the args description of the build_word_frequencies function, the type of the label is defined as list[str]. However in the unit test, the label is an integer numpy column vector
  • the type description should be corrected (e.g. with npt.NDArray[np.int_]) and eventually an example would help to identify the exact shape of the vector
@pkeilbach pkeilbach added documentation Improvements or additions to documentation assignments Assignment submissions or anything else related to the assignments labels Dec 6, 2024
@pkeilbach pkeilbach added this to the Winter term 2024/25 milestone Dec 6, 2024
@pkeilbach
Copy link
Owner

Good catch, @BeneHTWG 🚀 Would you want to work on this? My estimation would be 2 bonus points, as this fixes an incorrect type hint and provides a better example.

@BeneHTWG
Copy link
Contributor Author

BeneHTWG commented Dec 6, 2024

@pkeilbach yes, please assign me :)

@pkeilbach pkeilbach changed the title confusing docstring in assignment-2 Confusing docstring in assignment 2 Dec 6, 2024
@pkeilbach pkeilbach added the 🏅 1 bonus point label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
assignments Assignment submissions or anything else related to the assignments documentation Improvements or additions to documentation 🏅 1 bonus point
Projects
None yet
2 participants