Newcomers_Guide.rst: Include this blog post

[coala-bot]

This blog post will be helpful to all the newcomer's starting to contribute for coala. Add this somewhere in the Newcomers Guide with a good description. https://damngamerz.github.io/gsoc/An-Insight-Into-coala's-Structure.html difficulty/newcomer

Opened via gitter by @damngamerz

[twmr]

Wouldn't it be better if we create module-level docstrings to the __init__.py files of each coalib subpackage? We could then use these docstrings in the Newcomers guide, instead of linking to a blog post, which might get easily out of date.

[meetmangukiya]

I like the idea

[Makman2]

Me too, let's incorporate the blog into our API docs :+1:

[Makman2]

This is issue should be done by someone who has already a bit insight into coala's code structure.

[meetmangukiya]

@makman2 no, I meant to automatically include module level doctrings in a way that doesn't feel like they are generated ;)

[Makman2]

Oh :3 Doesn't exclude each other anyway :3

[Vedarth]

I would like work on this issue. Kindly assign it to me.

[Vedarth]

Just to be clear what we want to do is add docstrings to __init__.py of each coalib subpackage. But how should we use the in newcomer's guide? My guess is explain each subpackage of coalib. Kindly correct me if I am wrong. 😄

[Makman2]

I'm not sure too... I can't recover what was exactly wanted here. But documenting each package in __init__.py is not bad ;)

[Vedarth]

Alright so I will just add docstrings to submodules of coalib

[Vedarth]

@Makman2 I am still unsure. Do you want me to add docstrings to __init.py__ of each subpackage of coalib or add documentation of subpackages of coalib to necomers_guide.rst? We have to integrate the blog in newcomers_guide.rst right?

[Makman2]

Do you want me to add docstrings to init.py of each subpackage of coalib

This :+1:

We have to integrate the blog in newcomers_guide.rst right?

That's now the final question, and I'm unsure if we should do it, as it's not up-to-date.

[Makman2]

@Vedarth I have an idea, let's file a new issue for documenting everything in all __init__.pys, and then we discuss here again if we want to include the blog link again. I would assign you to this new issue.

[Makman2]

Oh there's already https://github.com/coala/coala/issues/4800, I've assigned you there now @Vedarth

[Makman2]

Blocked by https://github.com/coala/coala/issues/4800

Depending on how well we can document our structure there, we reconsider this issue.