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

[Docs] Find new applications examples for the docs #117

Open
Tracked by #114
lrnv opened this issue Feb 4, 2024 · 3 comments
Open
Tracked by #114

[Docs] Find new applications examples for the docs #117

lrnv opened this issue Feb 4, 2024 · 3 comments
Labels

Comments

@lrnv
Copy link
Owner

lrnv commented Feb 4, 2024

Link to JOSS review : openjournals/joss-reviews#6189

Luca wrote:

Currently the documentation feels to have more theory than code, it would be nice to expand the Examples section with a few more examples of how to use the code, ideally within some applications of how to solve some "real-world" problems. E.g. applying Copulas.jl to some popular datasets and concrete example problems.

Thus we need to find a use-case ona popular dataset or concrete problem to add it to the docs.

@Santymax98 Maybe you have in your work one simple use-case that could be shown ?

@lrnv lrnv mentioned this issue Feb 4, 2024
27 tasks
@lrnv lrnv added the JOSS label Feb 4, 2024
@lrnv lrnv changed the title Currently the documentation feels to have more theory than code, it would be nice to expand the Examples section with a few more examples of how to use the code, ideally within some applications of how to solve some "real-world" problems. E.g. applying Copulas.jl to some popular datasets and concrete example problems. [Paper] Expand the examples section with a few more examples. Feb 4, 2024
@lrnv lrnv changed the title [Paper] Expand the examples section with a few more examples. [Docs] Expand the examples section with a few more examples. Feb 7, 2024
@lrnv lrnv self-assigned this Feb 7, 2024
@lrnv lrnv changed the title [Docs] Expand the examples section with a few more examples. [Docs] Find new applications examples for the docs Feb 7, 2024
@lrnv
Copy link
Owner Author

lrnv commented Feb 23, 2024

@lucaferranti what do you think of the current state of the example section in the docs ? (look at the dev version there: https://lrnv.github.io/Copulas.jl/dev/ i did not pushed a new release to stable yet, so you can compare with stable directly).

If this is good for you, then please close this. Otherwise I can continue thinking of a few examples to add. Also consider the additions done for #142 that are more "spread out" in the documentation.

@lucaferranti
Copy link

I think the examples section looks much better now and I'm satisfied.

I cannot close this issue, but I've marked the box in the reivew checklist and notified the editor that the paper is ready from my side

@lrnv lrnv closed this as completed Feb 23, 2024
@lrnv lrnv reopened this Feb 23, 2024
@lrnv
Copy link
Owner Author

lrnv commented Feb 23, 2024

Reoppend because we have a last example to add before pushing a new version fully, will not take long IMHO.

@lrnv lrnv linked a pull request Feb 23, 2024 that will close this issue
@lrnv lrnv removed their assignment Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants