Cloud-CV / Cloud-CV/evalai-cli

Modify docstrings in functions

Open
#46 4 comments 0 reactions 1 assignee Claimed by @guyandtheworld View on GitHub
docs enhancement
Dominant language
Python
Stars
57
Forks
70
PR merge metrics
No merged PRs in 30d

Description

**Current Scenario:** Tells the functioning of the function in a single line.

**Deliverables:**
We should add doc strings answering the following points:
1. Args : What argument a function accepts
2. Returns: What is the final output of the function
3. Raises: What exception it raises
4. Command (Optional): What is command used to invoke it.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.