docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0#901
docs: deprecate SensorDataSeries and SensorDataSeriesList for removal in v4.0.0#901
Conversation
pmai
left a comment
There was a problem hiding this comment.
Minor wording changes, should also generally refer to the trace file formats, without discussing specific ones.
… in v4.0.0 The single-channel (.osi) and multi-channel (.mcap) trace file formats have fully superseded these messages: - .osi traces generalize SensorDataSeries to any top-level message type and support streaming without loading all timesteps into memory. - .mcap traces generalize SensorDataSeriesList to any combination of top-level message types with metadata, schemas, compression, and random access. Internal buffering by sensor models is an implementation concern and does not belong in the interface specification. Resolves #900 Signed-off-by: Carlo van Driesten <carlo.van-driesten@bmw.de>
2d468fc to
4220d86
Compare
|
Hark, good @pmai! Thy counsel, wise and true, Pray, review once more this humble scribe's revision, |
pmai
left a comment
There was a problem hiding this comment.
To Merge, or Not to Merge
O, most valiant contributor,
I have with attentive eye scanned these lines of artful code. Truly, 'tis a work of great merit and industrious soul! The logic, once a tangled thicket of doubt, now shines with the brightness of a thousand midday suns.
Though I didst search for flaws with the hunger of a ghost seeking vengeance, I find none. No bugs do creep within these shadows, and the performance—stay!—it hath the swiftness of a winged messenger.
"The play’s the thing..."
And in this play, thy script is flawless.
Mine heart is light; the conscience is clear. I do set my seal upon this endeavor with a glad spirit.
I pray you, let the gates be opened! LGTM.
Summary
Deprecates
SensorDataSeriesandSensorDataSeriesListinosi_datarecording.protowith\attentionnotes indicating removal in OSI 4.0.0.Motivation
As discussed in #900, these messages predate the OSI trace file formats and have been fully superseded:
SensorDataSeries.ositrace formatSensorDataSeriesList.mcaptrace formatThe original
\briefalso mentioned internal buffering by sensor models as a use case. This is an implementation concern of individual sensor models and does not belong in the interface specification.Changes
\briefforSensorDataSeries(removed the internal buffering language)\attentiondeprecation notes to bothSensorDataSeriesandSensorDataSeriesListexplaining the rationale and the superseding formatsRecommendation from maintainers
Per @jdsika, @pmai, and @thomassedlmayer in #900: deprecate now, remove entirely in v4.0.0.
Resolves #900