couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexander Shorin (JIRA)" <j...@apache.org>
Subject [jira] [Created] (COUCHDB-1865) Use HTTP API examples as tests...
Date Sun, 28 Jul 2013 14:41:49 GMT
Alexander Shorin created COUCHDB-1865:
-----------------------------------------

             Summary: Use HTTP API examples as tests...
                 Key: COUCHDB-1865
                 URL: https://issues.apache.org/jira/browse/COUCHDB-1865
             Project: CouchDB
          Issue Type: Improvement
          Components: Documentation, Test Suite
            Reporter: Alexander Shorin


...or use tests as HTTP API examples. 

First way is completely based on Sphinx ReST format: there is need to parse rst files, extract
required directives and convert them to test cases. That's a Python way to go since it already
contains package for parsing and operating with all required content.

The second way it about using  project like [katt|https://github.com/klarna/katt] which tests
HTTP API by using human-readable files for test cases. Currently, their format is similar
to Markdown, but I think it would be a problem to upgrade it to ReST, right? This way is completely
Erlang`ish.

First way is fast and cheap, but strict to sphinx docs content. Second is a bit longer, but
doesn't binds to docs since only part of his tests will be used as base for docs.
Which road better to go?

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message