Numerous documentation fixes and updates, wavread can now read chunks fixed after subrange #86
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
The `read_*_samples()` functions did not leave the `io` read position at the end of the `"data"` chunk if only a subrange that doesn't include the last sample was read, which caused parsing of subsequent chunks to fail. We therefore now pass on `chunk_size` to all the `read_*_sample()` functions, such that they all can now always skip to the end of the chunk.
…tion
There were numerous problems, e.g. default behaviour of optional
arguments was not explained correctly, there were references to types
such as Range1{} that no longer exist in Julia 1.x, etc.
Also syntax fixes for Documenter.jl
Instructions for hosting the resulting HTML documentation of GitHub Pages: https://juliadocs.github.io/Documenter.jl/stable/man/hosting/
|
Thanks for this contribution @mgkuhn. I will review as soon as I can. |
|
thanks so much for the docstrings!!! |
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.
The documentation of functions in README.md had gotten seriously out of sync with the actual implementation, so I have now moved it all into docstrings and updated everything that I could spot. This way the documentation also becomes available from Julia's built-in help system, and it can now be built with Documenter.jl. (Keeping the function documentation closer to the code makes it more likely that it gets updated in future.)
I've also removed or updated several broken links from README.md.
While testing the updated documentation, I also spotted and fixed two problems in the implementation:
includedoes understand relative paths)I've also added to
.travis.yamlthe lines needed for the CI to build the HTML documentation with Documenter.jl. If that works, you can then complete the steps required to automatically host the HTML documentation on GitHub Pages.