RadheDD
commented
4 weeks ago Thank you Bongani for your review.
Actually I felt the same about the comments 😅 Thank you for sharing the resource, I will go over it.
Many thanks,
On Tue, Aug 20, 2024, 19:22 Bongani Gumbo @.***> wrote:
Hey Ankita,
(You can delete this issue after going over it)
The code looks good, and as usual, your functions are well broken up.
This suggestion is a bit contradictory to the BootCamp, but there are too many comments😅 I'm a firm believe there the function should speak for itself and when you're writing functions that are this compact, there isn't really a need for any additional inline comments, someone reading the code should be able to gain the meaning from it through good function and variable naming.
That's not to say documentation isn't important. You can take a look at this https://hexdocs.pm/elixir/1.12.3/writing-documentation.html to see how you cand document Elixir functions.
The idea is for the doc to give an overview of the function and the code to speak for itself.
— Reply to this email directly, view it on GitHub https://github.com/RadheDD/Elixir_Projects/issues/1, or unsubscribe https://github.com/notifications/unsubscribe-auth/BHCKMFMDPQTAWHFBXXFLRN3ZSOCOLAVCNFSM6AAAAABM2OLKD2VHI2DSMVQWIX3LMV43ASLTON2WKOZSGQ3TMMRWGIYDGOI . You are receiving this because you are subscribed to this thread.Message ID: @.***>
Hey Ankita,
(You can delete this issue after going over it)
The code looks good, and as usual, your functions are well broken up.
This suggestion is a bit contradictory to the BootCamp, but there are too many comments😅 I'm a firm believe there the function should speak for itself and when you're writing functions that are this compact, there isn't really a need for any additional inline comments, someone reading the code should be able to gain the meaning from it through good function and variable naming.
That's not to say documentation isn't important. You can take a look at this to see how you cand document Elixir functions.
The idea is for the doc to give an overview of the function and the code to speak for itself.