Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2. Additional *** Tasks *** appearing in the docs #280

Closed
Tracked by #254
cmin764 opened this issue Nov 4, 2021 · 3 comments
Closed
Tracked by #254

2. Additional *** Tasks *** appearing in the docs #280

cmin764 opened this issue Nov 4, 2021 · 3 comments
Labels
bug Bad or unexpected behaviour documentation Improvement/addition to documentation onboarding Issue: Good first task for newcomers

Comments

@cmin764
Copy link
Contributor

cmin764 commented Nov 4, 2021

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
Copy link
Contributor Author

cmin764 commented Jan 13, 2022

Screenshot_2022-01-13_at_11_23_35

@cmin764 cmin764 removed their assignment Apr 19, 2022
@cmin764 cmin764 added the onboarding Issue: Good first task for newcomers label Apr 19, 2022
@cmin764
Copy link
Contributor Author

cmin764 commented Apr 19, 2022

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.

@osrjv osrjv assigned rihardsgravis and unassigned rihardsgravis Apr 19, 2022
@tonnitommi
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Bad or unexpected behaviour documentation Improvement/addition to documentation onboarding Issue: Good first task for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants