help(coalib) isnt very helpful #1663
Comments
|
Can I do this? |
|
@AdeshAtole hey, you've got an invitation to our team. Accept at github.com/coala-analyzer and we can assign you. |
|
thanks for your interest :) |
|
@sils1297 I have accepted the invite |
|
@AdeshAtole I've assigned this to you |
|
@AbdealiJK Please unassign me from this issue. I already have a PR merged for a newcomer issue. |
|
done |
|
Can I work on this? |
|
Sure! Let us know if you need anything or if the issue is unclear! |
|
@sils1297 I am a complete newbie to coala. Where do I find the coalib.init.py file? and what description needs to be shown after running help(coalib)?. Thanks in advance! |
|
For the |
|
@sils1297 What does 'description of coala/coalib' mean in the issue statement. A general overview of what the library does? |
There is no description of coalib provided in its help documentation. Thus this will take care of it. Closes coala#1663
README: Add `author_email` `author_email` must be provided when `author` in `setup.py`. rultor_secrets.sh.asc: Change key Contains two environment variables: * PYPIUSER * PYPIPW that correspond to the coala CI credentials. install.python-dbus.sh: Remove certificate check README: Fix pypi issue Circle: Use -V instead of -L DEBUG Bear: Use -V instead of -L DEBUG -V is more easier to understand and type for debugging. Closes coala#2688 README: Change version of 0.8.0 to 0.8.1 The version is outdated so we need to update it Closes coala#2742 __init__.py: Add help description There is no description of coalib provided in its help documentation. Thus this will take care of it. Closes coala#1663
There is no description of coalib provided in its help documentation. Thus this will take care of it. Closes coala#1663
There is no description of coalib provided in its help documentation. Thus this will take care of it. Closes coala#1663
Currently
import coalibfollowed byhelp(coalib)is not very useful. It just gives a list of packages inside. We should ideally have a description of coala/coalib there too.I think we need to add a doc-comment in coalib.init.py which gives better information.
We could also use this in the
setup.pymaybe ?The text was updated successfully, but these errors were encountered: