[Epic] Document Scribe-Android functions and classes

[andrewtavis]

Terms

• [x] I have searched open and closed issues
• [x] I agree to follow Scribe-Android's Code of Conduct

Issue

After #17 is finished, a the codes for Scribe-Android should be more fully documented to make future work and collaboration easier. All functions and classes should be given documentation headers, and all parts of the code that are complex should be explained. Comments should also be formatted so that those that are on their own line are a complete sentence.

[andrewtavis]

Do you think it would make sense to make sub issues for this, @angrezichatterbox? If so, is there a directory structure you'd suggest where maybe we could make an issue to document the functions in a certain directory or file? We can also talk about this in the sync as well 😊

[angrezichatterbox]

Do you think it would make sense to make sub issues for this, @angrezichatterbox? If so, is there a directory structure you'd suggest where maybe we could make an issue to document the functions in a certain directory or file? We can also talk about this in the sync as well 😊

Yes I think it makes sense. In specific I think we have to document the services directory first. Then we could have issues for the helpers directory. These for me are the important directories we could document.

[andrewtavis]

Ok, great 😊 I'll make issues for these two then :) Thanks for your feedback!

[angrezichatterbox]

Should we add more sub-issues for this issue for the documentation part

[andrewtavis]

Yes that sounds great, @angrezichatterbox :)

[andrewtavis]

Closing this via a discussion with @angrezichatterbox as we're realizing that all docstrings have been written and we have linting to let us know if there's anything missing in the future. Maybe we'll need another issue at some point, but we're good to close this one 😊 Thanks all for the great work here!