rpaframework icon indicating copy to clipboard operation
rpaframework copied to clipboard

2. Additional `*** Tasks ***` appearing in the docs

Open cmin764 opened this issue 4 years ago • 2 comments

A solution would be to append *** Tasks *** only in robotframework code blocks. (and the dev should write the examples in such a way they'll begin with the tasks (and not explicitly adding the tasks header ofc))

Another saner solution is to just remove this auto-addition of the *** Tasks *** header.

Screenshot_2021-11-04_at_16_25_36

cmin764 avatar Nov 04 '21 15:11 cmin764

Screenshot_2022-01-13_at_11_23_35

cmin764 avatar Jan 13 '22 09:01 cmin764

As @osrjv suggested, this is the place where the code should be altered.

Quick solution:

  1. If the *** Tasks *** header is already present in the code-block, then don't add it, otherwise add it at the beginning as it is right now.
  2. Don't add the *** Tasks *** header to Python code-blocks. (only in Robot Framework ones)
  3. ~Optional cover for *** Test Cases ***, since with RF5 terminology got replaced~.
  • More info on the expected docstring template in the Legend found here.
  • Additional related issue clarification.

cmin764 avatar Apr 19 '22 09:04 cmin764

This seems to be fixed. Closing until further issues arise. :)

tonnitommi avatar Mar 27 '23 09:03 tonnitommi