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

Docs: add example #96

Merged
merged 5 commits into from
May 23, 2024
Merged

Docs: add example #96

merged 5 commits into from
May 23, 2024

Conversation

heitorPB
Copy link
Contributor

@heitorPB heitorPB commented May 8, 2019

No description provided.

Copy link
Member

@ararslan ararslan left a comment

Choose a reason for hiding this comment

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

Seems fine in general I suppose, but a problem with examples is they're often not kept up to date when the rest of a repository is updated.

docs/src/examples.md Outdated Show resolved Hide resolved
docs/src/examples.md Outdated Show resolved Hide resolved
@ararslan ararslan requested a review from stevengj May 8, 2019 19:26
@ararslan ararslan dismissed their stale review May 8, 2019 20:20

Requested changes implemented

@heitorPB
Copy link
Contributor Author

heitorPB commented May 9, 2019

I agree with you. But the basic structure should not change enough to break a simple example like this one.

@ViralBShah
Copy link
Member

This one is really old - but I think it is ok to merge.

@heitorPB heitorPB requested a review from ararslan February 24, 2024 00:58
@ararslan
Copy link
Member

Sorry for the multi-year delay on this one, @heitorPB, and thanks for sticking with it!

Comment on lines +19 to +21
Ts = 1 / (1.1 * N)
# Sample rate
fs = 1 / Ts
Copy link

Choose a reason for hiding this comment

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

together, this is equivalent to saying that the sample rate is 1.1 * N Hz, i.e. 4504.5

Copy link
Member

@ararslan ararslan left a comment

Choose a reason for hiding this comment

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

Oops, I started a review hours ago and forgot to push submit

docs/src/examples.md Outdated Show resolved Hide resolved
docs/src/examples.md Outdated Show resolved Hide resolved
docs/src/examples.md Outdated Show resolved Hide resolved
docs/src/examples.md Outdated Show resolved Hide resolved
docs/src/examples.md Show resolved Hide resolved
docs/src/examples.md Show resolved Hide resolved
time_domain = plot(t, signal, title="Signal", xlims=(0, 4 / 60), xlabel="time (s)", label="")
freq_domain = plot(freqs, abs.(F), title="Spectrum", xlims=(0, 200), xlabel="frequency (Hz)", label="")
plot(time_domain, freq_domain, layout = 2)
savefig("Wave.pdf")
Copy link
Member

Choose a reason for hiding this comment

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

We could consider make this a Documenter @example block, which will render the output into the document.

Copy link
Member

Choose a reason for hiding this comment

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

(Btw, you don't have to make this change as part of this PR unless you want to. I mention it more as a note.)

Copy link

codecov bot commented May 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@be3f580). Learn more about missing BASE report.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #96   +/-   ##
=========================================
  Coverage          ?   73.45%           
=========================================
  Files             ?        5           
  Lines             ?      535           
  Branches          ?        0           
=========================================
  Hits              ?      393           
  Misses            ?      142           
  Partials          ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/src/examples.md Outdated Show resolved Hide resolved
Copy link
Member

@ararslan ararslan left a comment

Choose a reason for hiding this comment

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

Thanks so much for the contribution, @heitorPB!

@ararslan ararslan merged commit f84fddd into JuliaMath:master May 23, 2024
49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants