fix documentation typos #540
Conversation
|
Warning Rate limit exceeded@d-chambers has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 52 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughDocumentation-only edits across contributing guides, recipes, and tutorials: typo/grammar fixes, link and capitalization corrections, YAML metadata key normalization, expanded governance/leadership wording, clarified fork/upstream/PR workflow, and minor example/code-comment fixes. No code, API, or runtime changes. Changes
Possibly related PRs
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (11)
docs/recipes/overview.qmd (1)
5-5: Nice catch: “collapsible” spelling fix.Reads well. Optional: say “in the sidebar” instead of “on the left” to be layout-agnostic.
Apply if you want:
-Use the collapsible menu on the left to browse the recipes +Use the collapsible menu in the sidebar to browse the recipesdocs/tutorial/spool.qmd (1)
191-193: Typo fix LGTM; consider explicit units in the comment.Minor clarity tweak: include “s” to match API units.
-# Chunk spool for 3 second increments with 1 second overlaps -# and keep any segments at the end that don't have the full 3 seconds. +# Chunk spool for 3 s increments with 1 s overlaps +# and keep any segments at the end that don't have the full 3 s.docs/contributing/contributing.qmd (1)
49-52: Stale timeline reference (October 2023).This reads as future/planned but is now historical. Rephrase to be time-agnostic or update outcome.
Example:
-In October 2023 at a DASDAE developer team check-in, the team will review ... +At a DASDAE developer team check-in, the team reviews contributions and nominates a leadership team based on contribution history.docs/contributing/documentation.qmd (1)
168-169: Minor wording/capitalization: LaTeX and “Inline”.Tiny polish for terminology.
-Equations use standard latex. In line equations ($E=mc^2$) are surrounded +Equations use standard LaTeX. Inline equations ($E=mc^2$) are surroundeddocs/tutorial/coords.qmd (1)
337-339: Comment improvement LGTM; also check nearby cross-reference quotes.This hunk is good. Separately, earlier lines 315, 329, 343 use single quotes in cross-refs like select. Use backticks without extra quotes to ensure Quarto cross-refs render.
-[select]('dascore.core.coordmanager.CoordManager.select`) +[select](`dascore.core.coordmanager.CoordManager.select`)docs/recipes/fk.qmd (1)
72-73: Typo fix LGTM; add velocity units for clarity.Readers may assume m/s or km/s—be explicit.
-In this case, the P velocity is about 4500 and the S velocity is about 2700. +In this case, the P velocity is about 4500 m/s and the S velocity is about 2700 m/s.docs/tutorial/patch.qmd (2)
228-228: Minor grammar: add “with”.-These only work for patches with dimensions "time" and "distance" but can help new users who may be unfamiliar datetimes and coordinates. +These only work for patches with dimensions "time" and "distance" but can help new users who may be unfamiliar with datetimes and coordinates.
504-504: Fix typo “associted”.-# Add coordinate associted with multiple dimensions. +# Add coordinate associated with multiple dimensions.docs/recipes/docker_basic.qmd (1)
9-9: Tiny punctuation nit.-First you need to clone the DASCore main repository: +First, you need to clone the DASCore main repository:docs/recipes/how_to_contribute.qmd (2)
90-95: Add the missing clone command in Step 2.
Currently it jumps straight to cd; include clone examples.-```bash -cd dascore -``` +```bash +# Clone your fork (choose one): +# HTTPS: +git clone https://github.com/YOUR_USERNAME/dascore.git +# or SSH: +git clone [email protected]:YOUR_USERNAME/dascore.git +cd dascore +```
157-157: Escape placeholder in URL to avoid angle-bracket parsing.-Navigate to your project's GitHub repository, for instance, https://github.com/<your_username>/dascore, and click "Contribute" and then "Open a pull request". Then, create a pull request and provide a detailed title and description for your changes, explaining the rationale behind your pull request. +Navigate to your project's GitHub repository, for instance, `https://github.com/YOUR_USERNAME/dascore`, and click "Contribute" and then "Open a pull request". Then, create a pull request and provide a detailed title and description for your changes, explaining the rationale behind your pull request.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
docs/contributing/contributing.qmd(1 hunks)docs/contributing/documentation.qmd(3 hunks)docs/contributing/general_guidelines.qmd(2 hunks)docs/contributing/testing.qmd(1 hunks)docs/contributors.qmd(2 hunks)docs/recipes/docker_basic.qmd(1 hunks)docs/recipes/fk.qmd(1 hunks)docs/recipes/how_to_contribute.qmd(1 hunks)docs/recipes/overview.qmd(1 hunks)docs/recipes/smoothing.qmd(0 hunks)docs/tutorial/concepts.qmd(1 hunks)docs/tutorial/coords.qmd(4 hunks)docs/tutorial/patch.qmd(2 hunks)docs/tutorial/spool.qmd(1 hunks)
💤 Files with no reviewable changes (1)
- docs/recipes/smoothing.qmd
🔇 Additional comments (13)
docs/contributing/contributing.qmd (1)
33-34: Typo fix (“describe”) looks good.No further issues in this hunk.
docs/contributing/documentation.qmd (2)
8-8: Whitespace/wording tweak LGTM.The sentence now reads cleanly.
72-75: Quarto link correction LGTM.Accurate URL and guidance.
docs/tutorial/concepts.qmd (2)
37-39: Grammar fix LGTM.Clearer phrasing.
44-45: Corrected function reference LGTM.to_timedelta64 path is now correct.
docs/tutorial/coords.qmd (3)
115-116: Typo fix in comment LGTM.Accurate and consistent.
194-197: Clarity improvement LGTM.Reads well.
247-254: Comment fix LGTM.Good clarification for non-dimensional coord.
docs/contributing/testing.qmd (1)
2-2: Verify front matter 'title' casing across docs. Audit returned 0 matches for lowercasetitleunder docs — confirm whether front matter keys are capitalized or absent and normalize all front matter keys to lowercasetitlewhere present.docs/contributors.qmd (1)
8-8: Header tweak and URL fixes look good.
All corrections read well and the three links are now valid.Also applies to: 24-24, 26-26, 30-30
docs/tutorial/patch.qmd (1)
163-163: Typo fixes in comments are correct.
"corresponding" and "Disassociate" are now correctly spelled.Also applies to: 525-525
docs/recipes/docker_basic.qmd (1)
9-12: Docker quickstart edits read well and improve clarity.
The added clone step and mount explanation are correct.Also applies to: 14-18, 20-21
docs/contributing/general_guidelines.qmd (1)
12-14: Wording and punctuation improvements look good.
SemVer sentence and “i.e.” usage are now clearer.Also applies to: 26-26
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/recipes/fk.qmd (4)
75-77: Rename vars to match S‑wave focus.The text says the example highlights S waves, but the variable is named
filt_p. Rename for consistency.Apply:
-filt_p = np.array([1_000, 2_300, 3_000, 4_000]) -patch_filtered_p = patch_filtered.slope_filter(filt=filt_p) -patch_filtered_p.viz.waterfall(scale=1); +filt_s = np.array([1_000, 2_300, 3_000, 4_000]) +patch_filtered_s = patch_filtered.slope_filter(filt=filt_s) +patch_filtered_s.viz.waterfall(scale=1);
82-82: Fix minor grammar (“according to a”).Reads smoother and avoids ambiguity.
-Up/down (or left/right) separation is also possible using the `directional` keyword. Up-going (waves moving towards the interrogator according a decreasing distance value) have positive velocities and down-going (waves moving away from the interrogator) have negative velocities. +Up/down (or left/right) separation is also possible using the `directional` keyword. Up-going (waves moving towards the interrogator according to a decreasing distance value) have positive velocities and down-going (waves moving away from the interrogator) have negative velocities.
39-39: Capitalize DFT.Acronym should be uppercase.
-We can transform and visualize the patch in the F-K domain using the dft. +We can transform and visualize the patch in the F-K domain using the DFT.
7-7: Consistency: use “F‑K” or “FK” uniformly.Title uses “F‑K”, section uses “FK”. Pick one; suggest “F‑K” to match title.
-## FK transforms +## F-K transformsdocs/contributing/contributing.qmd (2)
33-36: Polish the dependency-size clause for readability (optional).Tweak phrasing to read more smoothly; also consider “biweekly” (no hyphen) for consistency with common style.
- describe the feature, the additional dependency (including approximate added size of the software - required to be installed), and ideas for other features that could be enabled by this dependency. + describe the feature, the additional dependency (including the approximate size of the additional + software to be installed), and ideas for other features this dependency could enable.
47-50: Clarify leadership selection cadence and standardize hyphenationAdd an explicit cadence/term for leadership selection and make "bi-weekly" vs "biweekly" consistent.
- Evidence: docs/contributing/contributing.qmd:32 contains "bi-weekly"; lines 47–49 are the insertion point with the BDFL text.
- Suggested wording: At a DASDAE developer team check-in (currently bi-weekly), the team reviews contributions and nominates a leadership team for the next cycle based on contribution history.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
docs/contributing/contributing.qmd(2 hunks)docs/contributing/documentation.qmd(3 hunks)docs/recipes/docker_basic.qmd(1 hunks)docs/recipes/fk.qmd(1 hunks)docs/recipes/overview.qmd(1 hunks)docs/tutorial/coords.qmd(5 hunks)docs/tutorial/patch.qmd(4 hunks)docs/tutorial/spool.qmd(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- docs/tutorial/coords.qmd
- docs/tutorial/spool.qmd
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/recipes/overview.qmd
- docs/tutorial/patch.qmd
- docs/contributing/documentation.qmd
- docs/recipes/docker_basic.qmd
⏰ 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). (1)
- GitHub Check: test_build_docs
🔇 Additional comments (1)
docs/recipes/fk.qmd (1)
72-72: LGTM: velocity units clarified.The “m/s” unit and conjunction fix improve clarity.
|
✅ Documentation built: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/recipes/fk.qmd (4)
39-39: Spell out acronym on first useMinor wording tweak: expand DFT once for clarity.
-We can transform and visualize the patch in the F-K domain using the DFT. +We can transform and visualize the patch in the F‑K domain using the discrete Fourier transform (DFT).
72-78: Clarify units in the example filterAdd a brief note that velocities are in m/s (since distance is meters and time is seconds) to avoid ambiguity.
-filt_s = np.array([1_000, 2_300, 3_000, 4_000]) +# velocities in m/s (distance in meters, time in seconds) +filt_s = np.array([1_000, 2_300, 3_000, 4_000])
82-82: Tighten phrasing on directionalitySlight wording improvement for readability.
-Up-going (waves moving towards the interrogator according to a decreasing distance value) have positive velocities +Up‑going (waves moving toward the interrogator, i.e., decreasing distance coordinate) have positive velocities
7-7: Standardize F-K terminology in docs/recipes/fk.qmdReplace mixed "F-k" and "FK" usages with "F-K" (found at lines 9 and 55).
-[F-k transforms](https://wiki.seg.org/wiki/F-k_filtering) are common +[F-K transforms](https://wiki.seg.org/wiki/F-k_filtering) are common-One advantage of the FK transform +One advantage of the F-K transform
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/contributing/contributing.qmd(2 hunks)docs/recipes/fk.qmd(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/contributing/contributing.qmd
⏰ 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). (1)
- GitHub Check: test_build_docs
Description
This PR fixes some typos in the documentation.
Checklist
I have (if applicable):
Summary by CodeRabbit