X Tutup
Skip to content

DOC specgram() documentation now in numpy style#7038

Closed
Exhor wants to merge 2 commits intomatplotlib:masterfrom
Exhor:numpy_doc_specgram
Closed

DOC specgram() documentation now in numpy style#7038
Exhor wants to merge 2 commits intomatplotlib:masterfrom
Exhor:numpy_doc_specgram

Conversation

@Exhor
Copy link
Copy Markdown
Contributor

@Exhor Exhor commented Sep 5, 2016

Changed documentation of lib/mlab.py for function specgram(), now in Numpy style.
@NelleV

Thanks.

Compute and plot a spectrogram of data in *x*. Data are split into
*NFFT* length segments and the spectrum of each section is
computed. The windowing function *window* is applied to each
Compute and plot a spectrogram of data in x. Data are split into
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why remove the special formatting on the argument names? It makes them stand out more.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It also makes it harder to read in plain text. I prefer it this way.

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Sep 6, 2016

It appears you have not set the config for your git client. All your commits are attributed to "Your Name you@example.com", which is probably not what you want.

The number of points of overlap between blocks. The default
value is 128.
mode : str, optional
What sort of spectrum to use, default is 'psd'.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There is trailing space at the end of this line. Can you please remove it?

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 6, 2016

Great job on this PR! the documentation looks much better now.
I think if you fix the different problems I mentionned, we'll be good to go.

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 11, 2016

It looks good and all the tests pass! Great job!

@tacaswell
Copy link
Copy Markdown
Member

Does this render right with the replacement params?

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 12, 2016

I'll check once I arrive home and add a screenshot to the PR.

On Sep 11, 2016 11:31 AM, "Thomas A Caswell" notifications@github.com
wrote:

Does this render right with the replacement params?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#7038 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AALR3t_FR-vh6fqUmuZ25_emeJKgU_xoks5qpEj8gaJpZM4J1Kqp
.

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 14, 2016

Here is how it renders.

specgram

@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented Sep 14, 2016

The name on the first commit needs to be fixed. If you are not comfortable with rebasing before hand, we need to remember to do so before merging.

@Exhor
Copy link
Copy Markdown
Contributor Author

Exhor commented Sep 15, 2016

Quite new to git. Rebase makes me scared.

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 15, 2016

@Exhor I'll take care of it :)
Thanks for your contribution!

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 15, 2016

Can you remind me your email address?

@Exhor
Copy link
Copy Markdown
Contributor Author

Exhor commented Sep 15, 2016

t.corradi@gmail.com

On 15 Sep 2016 5:12 pm, "Nelle Varoquaux" notifications@github.com wrote:

Can you remind me your email address?


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#7038 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AEOzJjXBs8slcDc0sH5PgVwdDZGmnXliks5qqW5GgaJpZM4J1Kqp
.

@NelleV
Copy link
Copy Markdown
Member

NelleV commented Sep 15, 2016

Thanks! I've rebased with this email address.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

X Tutup