Skip to content

Conversation

@d-chambers
Copy link
Contributor

@d-chambers d-chambers commented Sep 29, 2025

Description

A small change to make sure flip docstring builds in quarto (just needed to import numpy, worked fine with doctests).

Checklist

I have (if applicable):

  • referenced the GitHub issue this PR closes.
  • documented the new feature with docstrings or appropriate doc page.
  • included a test. See testing guidelines.
  • your name has been added to the contributors page (docs/contributors.md).
  • added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

  • Documentation
    • Updated numerous docs and tutorials for clarity, consistency, and typos (examples, wording, links, captions, and numeric values).
    • Made example snippets self-contained (added missing imports) and corrected code/sample names for copy‑paste usability.
    • Streamlined contributing and release guidance text for clearer formatting and instructions.
    • No behavioral or API changes; content and examples clarified only.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 29, 2025

Walkthrough

Updated docstrings and documentation text across the repository (minor editorial and formatting changes), plus a single docstring example import added in dascore/proc/basic.py. No executable code, logic, or public API changes.

Changes

Cohort / File(s) Change Summary
Docstring example update
dascore/proc/basic.py
Inserted import numpy as np into docstring examples for the flip function; no runtime or API modifications.
PR template
.github/pull_request_template.md
Reformatted checklist and combined bullets; purely textual/template edits.
Docs — contributing
docs/contributing/contributing.qmd, docs/contributing/new_format.qmd, docs/contributing/profiling_benchmarks.qmd, docs/contributing/publish_a_new_release.qmd, docs/contributing/style_and_linting.qmd
Minor wording, formatting, grammar, link fixes, and example command corrections; no behavioral changes.
Docs — notes
docs/notes/dft_notes.qmd, docs/notes/velocity_to_strain_rate.qmd
Corrected terminology, examples, numeric values, typos, and function name consistency; editorial updates only.
Docs — recipes
docs/recipes/low_freq_proc.qmd, docs/recipes/parallelization.qmd, docs/recipes/real_time_proc.qmd
Adjusted sampling/description text, fixed typos and formatting in code snippets and installation guidance; no code changes.
Docs — tutorial
docs/tutorial/transformations.qmd
Minor wording change for grammatical consistency; no API or code changes.

Possibly related PRs

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title fix_flip_docstring accurately identifies the primary change of updating the flip function’s docstring to include the numpy import and is concise and specific to the main change.
Description Check ✅ Passed The description includes a clear “## Description” section that explains the need for adding the numpy import for Quarto builds and a “## Checklist” section matching the repository template, so the structure is complete and aligned with the required format.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix_flip_docstring

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a2177b and df7cd60.

📒 Files selected for processing (12)
  • .github/pull_request_template.md (2 hunks)
  • docs/contributing/contributing.qmd (2 hunks)
  • docs/contributing/new_format.qmd (2 hunks)
  • docs/contributing/profiling_benchmarks.qmd (1 hunks)
  • docs/contributing/publish_a_new_release.qmd (1 hunks)
  • docs/contributing/style_and_linting.qmd (2 hunks)
  • docs/notes/dft_notes.qmd (9 hunks)
  • docs/notes/velocity_to_strain_rate.qmd (1 hunks)
  • docs/recipes/low_freq_proc.qmd (4 hunks)
  • docs/recipes/parallelization.qmd (1 hunks)
  • docs/recipes/real_time_proc.qmd (2 hunks)
  • docs/tutorial/transformations.qmd (1 hunks)
✅ Files skipped from review due to trivial changes (7)
  • docs/contributing/new_format.qmd
  • docs/contributing/publish_a_new_release.qmd
  • docs/contributing/style_and_linting.qmd
  • docs/contributing/profiling_benchmarks.qmd
  • docs/recipes/parallelization.qmd
  • docs/recipes/real_time_proc.qmd
  • .github/pull_request_template.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (19)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (macos-latest, 3.13)
  • GitHub Check: test_code (macos-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.10)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (windows-latest, 3.13)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code (ubuntu-latest, 3.12)
  • GitHub Check: test_code (ubuntu-latest, 3.10)
  • GitHub Check: test_code (macos-latest, 3.11)
  • GitHub Check: test_code (macos-latest, 3.10)
  • GitHub Check: test_code (ubuntu-latest, 3.13)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code (ubuntu-latest, 3.11)
  • GitHub Check: test_build_docs
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
  • GitHub Check: Run benchmarks
🔇 Additional comments (23)
docs/notes/velocity_to_strain_rate.qmd (1)

80-80: LGTM! Typo corrected.

The typo "tha" has been correctly fixed to "the".

docs/tutorial/transformations.qmd (1)

7-7: LGTM! Grammatical improvement.

The change from "or access as" to "or accessed as" improves parallel structure with "can be found" earlier in the sentence.

docs/contributing/contributing.qmd (3)

13-13: LGTM! Typo correction improves consistency.

The correction from "DAScore" to "DASCore" fixes a typo and maintains consistency with the project name throughout the documentation.


23-25: LGTM! Editorial improvements enhance readability.

The rewording and condensation of the packaging guidance section improves clarity and flow while preserving the original meaning.


29-31: LGTM! Leadership section is more concise.

The rewording makes the leadership and governance section more direct and easier to read while retaining all essential information about current structure and future rotation plans.

docs/recipes/low_freq_proc.qmd (6)

35-36: LGTM! Nyquist frequency calculation is correct.

The updated comment and calculation correctly reflect a 1-second sampling interval, yielding a Nyquist frequency of 0.5 Hz.


38-38: LGTM! Typo corrected.

Fixed "ailiasing" to "aliasing" - correct spelling of the signal processing term.


50-50: LGTM! Grammar improved.

Corrected possessive phrasing to "machine's memory size" for proper grammar.


129-129: LGTM! Formatting corrected.

Fixed backtick formatting for chunk_size reference to ensure consistency.


164-164: LGTM! Capitalization normalized.

Standardized capitalization to lowercase "visualization" for consistency with comment style.


1-169: Note: PR objectives mention flip docstring changes, but this file contains only documentation improvements.

The PR description mentions "a small change to ensure the flip docstring builds in Quarto by importing numpy" and references changes in dascore/proc/basic.py. However, this file (docs/recipes/low_freq_proc.qmd) only contains documentation improvements (typo fixes, grammar corrections, and updated Nyquist frequency calculations). All changes in this file are correct and improve documentation quality.

docs/notes/dft_notes.qmd (12)

7-7: LGTM!

The terminology "coordinate spacing" is precise and consistent with the mathematical framework discussed throughout the document.


58-58: LGTM!

The change from "time series" to "signal" makes the statement more general and aligns with the mathematical framework, since Fourier transforms apply to any signal, not just time series.


69-69: LGTM!

The clarification that the sum doesn't consider sample spacing accurately explains why numpy's DFT zero frequency doesn't match the continuous transform's integral property.


73-73: LGTM!

Using singular "sine wave" is grammatically correct since equation 5 describes a single sinusoidal function.


86-86: LGTM!

The correction from 5 Hz to 2 Hz aligns with the actual code implementation at line 124 where freq = 2 is defined, ensuring consistency between the narrative and the executable examples.


90-90: LGTM!

Typo correction from "unscalled-plot" to "unscaled-plot" is correct.


112-112: LGTM!

The function rename from plot_amplitude_spectras to plot_amplitude_spectra is grammatically correct since "spectra" is already the plural form of "spectrum". All function calls throughout the document (lines 136, 152, 199, 245) have been consistently updated.


140-140: LGTM!

The correction to reference 2 Hz (instead of the previous 5 Hz) ensures the narrative matches the actual code implementation where freq = 2 is defined.


148-148: LGTM!

The label "fig-n-scaled-plot" appropriately describes the figure showing the amplitude spectrum scaled by the number of samples (n).


185-185: LGTM!

The explicit mention of "sample spacing ($dx$)" provides clear terminology that connects to the mathematical notation used throughout the document.


194-195: LGTM!

The label and caption correctly describe that this figure shows the amplitude spectrum scaled by the coordinate spacing (dx), which is the key insight of this section.


203-203: LGTM!

The phrasing "transforms with different numbers of points" clearly describes what is being compared in the analysis.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Sep 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.92%. Comparing base (2cb70d6) to head (df7cd60).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #560   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files         127      127           
  Lines       10616    10616           
=======================================
  Hits        10608    10608           
  Misses          8        8           
Flag Coverage Δ
unittests 99.92% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
dascore/proc/basic.py (1)

773-785: Docstring import fix for Quarto — LGTM.

Adding import numpy as np makes the example self-contained and should resolve the Quarto build issue where np was undefined. Consistent with other examples in this module.

Before merging, please:

  • Re-run the Quarto docs build and doctests to confirm no regressions.
  • Tick the PR checklist items (link the issue closed, doc/test note, add yourself to contributors, add ready_for_review label).

Happy to help batch-check for other docstrings that use np without an import if you want a quick sweep.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2cb70d6 and 9a2177b.

📒 Files selected for processing (1)
  • dascore/proc/basic.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (18)
  • GitHub Check: test_code (windows-latest, 3.10)
  • GitHub Check: test_code (windows-latest, 3.12)
  • GitHub Check: test_code (windows-latest, 3.13)
  • GitHub Check: test_code (windows-latest, 3.11)
  • GitHub Check: test_code (ubuntu-latest, 3.13)
  • GitHub Check: test_code_min_deps (macos-latest, 3.13)
  • GitHub Check: test_code (macos-latest, 3.12)
  • GitHub Check: test_code (macos-latest, 3.11)
  • GitHub Check: test_code_min_deps (macos-latest, 3.12)
  • GitHub Check: test_code (ubuntu-latest, 3.10)
  • GitHub Check: test_code_min_deps (windows-latest, 3.12)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
  • GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
  • GitHub Check: test_code_min_deps (windows-latest, 3.13)
  • GitHub Check: test_code (ubuntu-latest, 3.11)
  • GitHub Check: test_code (macos-latest, 3.10)
  • GitHub Check: test_code (ubuntu-latest, 3.12)
  • GitHub Check: Run benchmarks

@codspeed-hq
Copy link

codspeed-hq bot commented Sep 29, 2025

CodSpeed Performance Report

Merging #560 will not alter performance

Comparing fix_flip_docstring (df7cd60) with master (2cb70d6)

Summary

✅ 50 untouched

@d-chambers d-chambers added the documentation Improvements or additions to documentation label Sep 30, 2025
@github-actions
Copy link

github-actions bot commented Sep 30, 2025

✅ Documentation built:
👉 Download
Note: You must be logged in to github and a DASDAE member to access the link.

@d-chambers
Copy link
Contributor Author

I added a few more typo fixes since I was messing with the docs anyway.

@d-chambers d-chambers merged commit d843736 into master Sep 30, 2025
24 checks passed
@d-chambers d-chambers deleted the fix_flip_docstring branch September 30, 2025 12:15
@coderabbitai coderabbitai bot mentioned this pull request Oct 4, 2025
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants