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

303 documentation or code error for vel frame #439

Merged
merged 3 commits into from
Dec 13, 2024

Conversation

mpound
Copy link
Collaborator

@mpound mpound commented Dec 10, 2024

  • Corrects documentation in velocity frames notebook.
  • Changes behavior of spectrum.plot() such that if x-axis is velocity and velocity frame is not given, it defaults to the frame in VELDEF keyword rather than the topographic frame frequency default in the velocity_frame attribute of Spectrum.
  • Adds a cell to velocity frames notebook. demonstrating above.

Although this is the desired behavior in the issue report, I am not entirely convinced this is behavior we want, because it is special casing one type of call to plot(). However, if Spectrum.velocity_frame was changed by the user via dysh (e.g. Spectrum.set_frame), then VELDEF will also get changed the behavior should still match user expectations.

@mpound mpound linked an issue Dec 10, 2024 that may be closed by this pull request
@mpound mpound requested a review from etsmit December 10, 2024 04:12
@mpound mpound merged commit be55a6b into main Dec 13, 2024
11 checks passed
@mpound mpound deleted the 303-documentation-or-code-error-for-vel-frame branch December 13, 2024 00:21
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.

Documentation or code error for vel frame
2 participants