Commit f0258644 authored by Michele Carignani's avatar Michele Carignani
Browse files

improved documentation and testing

parent e724f267

Readme.md

+3 −0
Original line number Diff line number Diff line
@@ -21,6 +21,9 @@ Command line arguments: 
Other configurable paramenters may be found in `config.py`, such as:



* ` DOC_CLAUSE_LVL_*`, the starting number for the sections numbering, with `LVL_1` being the number of the toplevel clause.

* `DRY_RUN`, if True, no output Docx file is created

* `QUIET`, if True, output on stdout is minimized

* `GIT_COMMIT_PREFIX`, If not empty, a NOTE is added after each test with this URL concatenated to the name of the Robot file(s) in input





## How to write the tests

robot2doc/main.py

+3 −0
Original line number Diff line number Diff line
@@ -40,6 +40,9 @@ def keywords_to_text(kws): 
    return "\n".join(map(keyword_to_line, kws))



def gen_test(suite, this_test, spec, sec, subsec, workspace):

    '''

    Generate the Docx part for an individual test

    '''

    global DRY_RUN



    tp = TP(this_test.doc)

tests/test_robot2doc.py

deleted100644 → 0
+0 −6
Original line number Diff line number Diff line 
#!/env/python



import robot2doc



def test_keyword_to_line():

    assert keyword_to_line("a", "b", "c") == "a b c" 
 No newline at end of file