search

Cloud-CV / evalai-cli

:cloud: :rocket: Official EvalAI Command Line Tool
https://cli.eval.ai
BSD 3-Clause "New" or "Revised" License
55 stars 63 forks source link

Modify docstrings in functions #46

Open RishabhJain2018 opened 6 years ago

RishabhJain2018 commented 6 years ago

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.
RishabhJain2018 commented 6 years ago

@varunagarwal @deshraj What do you guys say?

deshraj commented 6 years ago

Totally agree with what @RishabhJain2018 said. @isht3 can you please get this done quickly. This will be a bonus for our CLI.

guyandtheworld commented 6 years ago

Yes, will get started on this.

guyandtheworld commented 6 years ago

87 Fixes this.