hades icon indicating copy to clipboard operation
hades copied to clipboard

Create ex_doc for context modules

Open lbighetti opened this issue 8 years ago • 4 comments

lbighetti avatar Dec 23 '17 17:12 lbighetti

Are we going to use the GitHub wiki as a documentation repository ?

gabbian1 avatar Dec 28 '17 14:12 gabbian1

Sorry I should have written a better description, I meant more ex_doc on relevant functions/modules.

lbighetti avatar Dec 28 '17 17:12 lbighetti

I am not sure if this issue is meant to be a specific task for the entire project, but this documentation should be must-have on all implementations already, don't you think? I mean, as we must have tests for all new functions and modules, they should have their own documentation without the need to have a specific task for it. WDYT?

rafaels88 avatar Jan 02 '18 16:01 rafaels88

@rafaels88 I think some modules make more sense than others to have in-code documentation such as ex_docs. I believe mostly where the module is being shared within several parts of the application. For me this is the case for the context modules - in our case Mentorships and Accounts. Those definitely would be great to have ex_docs as they are reused several times and will potentially be reused more for future features.

Does that make sense ? Let me know your thoughts.

@pacheco7 for general documentation we can start with REAME i think. Perhaps we can move to wiki when we reach a point where the content is too extensive or too complex for the README. What do you think?

lbighetti avatar Jan 05 '18 13:01 lbighetti