Proper docstring is required for better readibility

Open

#2 opened on Oct 26, 2020 0 comments 0 reactions 0 assignees View on GitHub

Dominant language: Python
Stars: 10
Forks: 5
PR merge metrics: No merged PRs in 30d

Description

Use proper docstring everywhere in **english** as this package use complex logic, and it is hard to understand for an external user or for you in the future.

I use a lot of code definition inspector and good docstring helps a lot and it is for me more important than comments

e.g.

![macro 1](https://user-images.githubusercontent.com/22787340/97151287-9b585c00-176f-11eb-9169-5288437d800e.PNG)
![macro 2](https://user-images.githubusercontent.com/22787340/97151291-9bf0f280-176f-11eb-8329-32615867e0e1.PNG)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Proper docstring is required for better readibility

Description

Contributor guide

Assessment

Get new issues in your inbox