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

Group doctests into chunks #102

Open
alaindanet opened this issue Feb 4, 2023 · 1 comment
Open

Group doctests into chunks #102

alaindanet opened this issue Feb 4, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@alaindanet
Copy link
Contributor

alaindanet commented Feb 4, 2023

As a general trend within doctests in the package now, I think we could now transform all doctest lines with no expected output into chunks. Here for instance, instead of:

```jldoctest
julia> foodweb = FoodWeb([0 0; 1 0]);

julia> params = ModelParameters(foodweb);

julia> B0 = [0.5, 0.5];

julia> sol = simulate(params, B0);

julia> species_richness(sol; last = 10)
2.0

Prefer

```jldoctest
julia> foodweb = FoodWeb([0 0; 1 0]);
       params = ModelParameters(foodweb);
       B0 = [0.5, 0.5];
       sol = simulate(params, B0);
       species_richness(sol; last = 10)
2.0

I need to admit that this is my bad for not having figured we could do this within jldoctest chunks from the beginning. Now this associated poor style has become pervasive throughout the project :'( So, yeah, don't worry too much about tracking them down, we might do a whole pass over the docs to fix this everywhere later on ;)

Originally posted by @iago-lito in #87 (comment)

@iago-lito iago-lito added the documentation Improvements or additions to documentation label Feb 6, 2023
@iago-lito iago-lito changed the title Group doctests into chucks Group doctests into chuncks Jun 19, 2023
@iago-lito iago-lito changed the title Group doctests into chuncks Group doctests into chunks Jun 19, 2023
@iago-lito
Copy link
Collaborator

iago-lito commented Mar 15, 2024

Addressed as part of #140.

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

No branches or pull requests

2 participants