Standardize plot generic first-argument name to object for biomass/yield APIs#358
Merged
gustavdelius merged 3 commits intoJun 4, 2026
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix inconsistent first-argument name in plot generics
Standardize plot generic first-argument name to Jun 4, 2026
object for biomass/yield APIs
gustavdelius
requested changes
Jun 4, 2026
Member
There was a problem hiding this comment.
@copilot remove the tests you added
gustavdelius
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
plotBiomass(),plotYield(), andplotYieldGear()were inconsistent with the rest of the plotting API by naming the S3 dispatch argumentsiminstead ofobject. This change aligns those generics (and related methods/wrappers) with package conventions and records the named-argument impact as a breaking change.API surface alignment
sim→objectin:plotBiomass(),plotYield(),plotYieldGear()genericsplotBiomass.MizerSim(),plotYield.MizerSim(),plotYieldGear.MizerSim()plotlyBiomass(),plotlyYield(),plotlyYieldGear()R/plots.Rto useobject.Documentation sync
man/plotBiomass.Rdman/plotYield.Rdman/plotYieldGear.RdBreaking-change note
sim = ...must switch toobject = ....