Documentation clarifications #410
Open
Conversation
This file contains hidden or 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
* Clarifies range of python integer input to write(), addressing issue bastibe#405. * Clarifies endianness of buffer_write input, which came up in issue bastibe#407. * Clarifies how to build the docs, which confused me while preparing this PR (Simply installing Sphinx is not enough)
bastibe requested changes Oct 4, 2023
| ``np.array([42], dtype='int32')``, to a ``subtype='FLOAT'`` | ||
| file, the file will then contain ``np.array([42.], | ||
| dtype='float32')``. | ||
| * For pure Python (non-Numpy) input values, floats will |
There was a problem hiding this comment.
I think this wording could be misunderstood. I would rephrase it as "floats are expected in in the range ... and integers in the range ...".
| Need a response on this comment before proceeding |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
This addresses some things I had trouble with while learning to use python-soundfile.