Eddiebot: Comments missing for help.ts

[mikeysan]

I was just reviewing the code here https://github.com/eddiejaoude/EddieBot/blob/master/src/help.ts but found it difficult to follow as there are no comments.

I know it's early days, so no pressure :)

[BOLT04]

@eddiejaoude is this issue stale and can we close it? I couldn't find the file help.ts, maybe it was renamed or deleted.

[eddiejaoude]

Help got moved to here https://github.com/EddieJaoudeCommunity/EddieBot/blob/develop/src/commandHandlers/help.ts

It is probably still relevant for all commands. I think you mentioned it too @BOLT04 that we need some docs on how to add a command to the project

[BOLT04]

Would that documentation go to the README @eddiejaoude ? Or a folder called docs at the root of the project?
Also @mikeysan, could you elaborate on what your difficulty was when reading the code? Even though the file changed quite a bit, your feedback would help creating the documentation and the comments that are necessary 😃

[eddiejaoude]

I think for now, we keep adding to the README and when it gets too big we will start splitting things out and keep the high level / important stuff in the README and more details in docs

[mikeysan]

@BOLT04 It was my initial look-in. I was trying to read the code to understand the flow of what was going on. I don't know Typescript, but I am pretty good at reading through code to get a gist of what its doing; especially when it has comments. That's what I was looking for. I like that the scope has been expanded to include a more general documentation of what the bot does. I think that's useful too.

I hope that helps.