-
Notifications
You must be signed in to change notification settings - Fork 6
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
Integrate doctest and enhanced examples #11
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
11bcd96
to
df4239d
Compare
Signed-off-by: Erik Buer <buer94@gmail.com>
df4239d
to
2bf8150
Compare
Signed-off-by: Erik Buer <buer94@gmail.com>
2685526
to
314256a
Compare
Signed-off-by: Erik Buer <buer94@gmail.com>
Signed-off-by: Erik Buer <buer94@gmail.com>
Hello @ErikBuer, Thank you so much for this comprehensive pull request. I completely agree, and the documentation changes are highly appreciated. Ensuring that the environment can be easily tested is also a necessity, and I sincerely thank you for addressing this! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi.
First off, what an amazing package you have made!
I thought i could help out with some documentation and visualization :)
Docs and Doctest
This PR adds support for doctest, that are embedded in function documentation. They are called through
runtests.jl
, as with the other tests. I´ve added two doc-tests as a beginning, feel free to change them to your liking. I just want a small running example.I'd like to add doctests to more functions, as I find them as good for getting started with a library.
Seven functions were missing in the documentation, so I have added them.
Examples
I have made some small fixes to the markdown files, to clear up some markdown linter warnings.
There were some examples with code, that generated a plot.
I have implemented a setup so code examples can be written as
@example
that actually run when we build the docs.This way we know that the examples work, and they generate the necessary figures while building the docs.
I have migrated
example_AWGN.md
so you can see a working example.The example can now be mixture between code and text. The migrated example looks like so:
![image](https://private-user-images.githubusercontent.com/47660770/293413934-90bff79e-711d-4b3a-a986-a924e8a2af00.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQ4NjQ2MTMsIm5iZiI6MTcyNDg2NDMxMywicGF0aCI6Ii80NzY2MDc3MC8yOTM0MTM5MzQtOTBiZmY3OWUtNzExZC00YjNhLWE5ODYtYTkyNGU4YTJhZjAwLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjglMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODI4VDE2NTgzM1omWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTkxN2Q4MjlhNTlkNTE4ZTE4MmU5ZTBiYWI3NmVjMzE1NGZhZmQ1NDMzYjcyY2ViNTZiYTUxZWFkMjNjZjBkMzUmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.li5omwsKKNfdYYokMupJWWTn7RH_vcdhM3lj5fkoZhQ)
Building docs
I have made some changes to
make.lj
such that dependencies to run tests, and generate documentation is not included in the package itself.I have added a CI to dry-run-build the documentation, so I was able to test the CI in my fork.
Should make things a bit easier for other contributors, being able to run the CI in their fork before creating a PR.
Now that the docs has its own dependencies, it is important to run it from the correct path, so not to add docs packages to the comms package toml.