Skip to content

Doc improvement suggestion: Simple runnable examples #24

New issue

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

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

Already on GitHub? # to your account

Closed
MasonProtter opened this issue Jun 3, 2021 · 1 comment · Fixed by #25
Closed

Doc improvement suggestion: Simple runnable examples #24

MasonProtter opened this issue Jun 3, 2021 · 1 comment · Fixed by #25
Labels
documentation Improvements or additions to documentation

Comments

@MasonProtter
Copy link

MasonProtter commented Jun 3, 2021

This looks really interesting! In particular, when I read this line:

ReTest is a testing framework for Julia allowing:

  • Defining tests in source files, whose execution is deferred and triggered on demand.

  • This is useful when one likes to have definitions of methods and corresponding tests close to each other. This is also useful for code which is not (yet) organized as a package, and where one doesn't want to maintain a separate set of files for tests.

I got quite interested, but then reading further in the docs, I fas faced with a lot of quite verbose, technical documentation and no examples (that I could find) on how to actually do this or what it'd look like.

A very simple, self contained, runnable example of defining a test next to a method near the beginning of the docs I think would be very helpful.

@MasonProtter MasonProtter changed the title Doc improvement suggestion: Simple examples Doc improvement suggestion: Simple runnable examples Jun 3, 2021
@rfourquet rfourquet added the documentation Improvements or additions to documentation label Jun 4, 2021
@rfourquet
Copy link
Contributor

Thanks for the feedback! Can you have a look and review #25 ?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants