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

Improve readability of examples #1101

Open
sbastrakov opened this issue Jul 28, 2020 · 0 comments
Open

Improve readability of examples #1101

sbastrakov opened this issue Jul 28, 2020 · 0 comments

Comments

@sbastrakov
Copy link
Member

sbastrakov commented Jul 28, 2020

As we discussed today, triggered by how the hello world example looks in new readthedocs #1093 , there are a couple of things we can do to improve readability and user-friendliness of the examples without changing their essence:

  • make work div selection portable Use getValidWorkDiv() in examples instead of manually setting it #1100
  • remove some of the lengthy comments of what is a queue, etc., as this belongs more to readthedocs
  • gradually decouple the examples from the CI, so that ideally there is no guards or other mentions in the example bodies, and the necessary logic moved to the CI side. This may be not that easy to do, will need to investigate.
@sbastrakov sbastrakov added this to the Version 0.6.0 milestone Jul 28, 2020
@j-stephan j-stephan added this to To do in Release 0.8 via automation May 11, 2021
@j-stephan j-stephan removed this from To do in Release 0.8 Nov 10, 2021
@j-stephan j-stephan added this to To do in Release 0.9 via automation Nov 10, 2021
@j-stephan j-stephan removed this from the Version 0.9.0 (I/2022) milestone Mar 29, 2022
@j-stephan j-stephan removed this from To do in Release 0.9 Mar 29, 2022
@j-stephan j-stephan added this to To do in Release 1.0 via automation Mar 29, 2022
@bernhardmgruber bernhardmgruber removed this from To do in Release 1.0 Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants