qiita icon indicating copy to clipboard operation
qiita copied to clipboard

Published 20 hours ago • verified publisher icon qiita-spots

Standardizing documentation

Open mortonjt opened this issue 10 years ago • 2 comments
trafficstars

May want to consider correcting/standardizing of the code documentation. For instance in qiita_db/metadata_template/base_metadata_template.py there are some methods with DataFrame in the Parameters section that should actually be pd.DataFrame

mortonjt avatar Oct 12 '15 03:10 mortonjt

Related to #321, is there any way to programmatically check that we are doing this right? IIRC the answer is no.

ElDeveloper avatar Oct 12 '15 15:10 ElDeveloper

I was looking into @ElDeveloper question and found this https://interrogate.readthedocs.io/en/latest/. I think it will be wroth adding to Qiita so we can review/cleanup things. In case, someone is wondering:

(qiita) 13:24:16 qiita@dev$ interrogate qiita_core/
RESULT: FAILED (minimum: 80.0%, actual: 46.6%)
(qiita) 13:24:21 qiita@dev$ interrogate qiita_db/
RESULT: FAILED (minimum: 80.0%, actual: 44.9%)
(qiita) 13:24:24 qiita@dev$ interrogate qiita_pet/
RESULT: FAILED (minimum: 80.0%, actual: 13.4%)
(qiita) 13:24:29 qiita@dev$ interrogate qiita_ware/
RESULT: FAILED (minimum: 80.0%, actual: 39.9%)
(qiita) 13:24:33 qiita@dev$ interrogate qiita_*
RESULT: FAILED (minimum: 80.0%, actual: 35.2%)

antgonza avatar Sep 02 '20 19:09 antgonza