Conversation
There was a problem hiding this comment.
Code Review
This pull request renames the x_lab and y_lab parameters to xlab and ylab in the draw_spectrogram function and its documentation, while also introducing a name_location property for axes. A copy-paste error was identified in the y-axis configuration where the name_location logic incorrectly references xlab instead of ylab.
There was a problem hiding this comment.
Pull request overview
Aligns draw_spectrogram()’s axis-label argument names with the rest of the drawing API (xlab/ylab) and adjusts axis title positioning to render in the middle.
Changes:
- Renames
x_lab/y_labarguments toxlab/ylabin code and documentation. - Centers axis names via
name_location = "middle"behavior in the EChartsAxisoptions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| r/R/draw_spectrogram.R | Renames axis label args and sets ECharts axis name positioning. |
| r/man/draw_spectrogram.Rd | Updates generated Rd usage/arguments to xlab/ylab. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| show_colorbar = TRUE, | ||
| colorbar_title = NULL, | ||
| title = NULL, | ||
| x_lab = NULL, | ||
| y_lab = NULL, | ||
| xlab = NULL, | ||
| ylab = NULL, |
There was a problem hiding this comment.
Renaming x_lab/y_lab to xlab/ylab is a breaking API change: existing user code calling draw_spectrogram(..., x_lab = ...) will now error with an unused argument. Consider keeping x_lab/y_lab as deprecated aliases (and mapping them to xlab/ylab, with a warning if both are provided) for at least one release cycle.
No description provided.