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

Renaming fields #30

Open
crotwell opened this issue Jul 24, 2017 · 0 comments
Open

Renaming fields #30

crotwell opened this issue Jul 24, 2017 · 0 comments

Comments

@crotwell
Copy link
Collaborator

Small issue, but I think it would be cleaner to rename some of the fields.

Data publication version -> Publication version: it is not just relevant to the data part, a header change could also trigger a version increment.

Length of time series identifier -> Byte length of channel identifier Bytes makes clear the length is byte count. Maybe potential for unicode in future, in which case string length is different. I am not advocating unicode by the way. Also this identifies the channel the time series came from, not the time series itself.

Length of extra headers -> Byte length of extra headers Bytes makes clear what the length is, this is not the number of extra headers.

Length of data payload -> Byte length of timeseries Bytes makes clear what the length is, not number of samples. Also call it timeseries instead of data payload.

Time series identifier -> Channel identifier identifies the channel the time series came from, not the time series itself.

Data payload -> Timeseries Clearer as to what this is, the data part is a timeseries, not some generic data.

I would also use the word "Channel identifier" instead of "time series identifier" in the FDSN Identifiers document. To me a "time series" is the output data samples, not the source of the data samples.

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

No branches or pull requests

1 participant