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

DOC: Cleanup wav read/write docs and add tables for common types #5991

Merged
merged 2 commits into from
Mar 23, 2016

Conversation

endolith
Copy link
Member

No description provided.

@endolith
Copy link
Member Author

also I think it's a bug that write accepts int8 type? should only accept uint8?

@codecov-io
Copy link

@@            master   #5991   diff @@
======================================
  Files          238     238       
  Stmts        43768   43768       
  Branches      8221    8221       
  Methods          0       0       
======================================
  Hit          34197   34197       
  Partial       2602    2602       
  Missed        6969    6969       

Review entire Coverage Diff as of 2aa34b4

Powered by Codecov. Updated on successful CI builds.

Return the sample rate (in samples/sec) and data from a WAV file.

Parameters
----------
filename : string or open file handle
Input wav file.
Input wav file. This can be an open file or a filename.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need this since it's in the types above?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I just moved it from the Notes section

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we really need it either place -- seems clear enough from the enumerated types. WDYT?

@larsoner larsoner added scipy.signal Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Mar 22, 2016
@endolith
Copy link
Member Author

Ok, changed those things and rebased

Add tables clarifying that 8-bit is unsigned, giving max and min values
@larsoner
Copy link
Member

Thanks @endolith

@larsoner larsoner merged commit 42e9e85 into scipy:master Mar 23, 2016
@endolith endolith deleted the wave_docs branch March 23, 2016 15:49
@ev-br ev-br added this to the 0.18.0 milestone Mar 26, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.signal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants