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

Rename xxxInSeries to seriesXxx #34

Merged
merged 2 commits into from
Apr 7, 2020
Merged

Rename xxxInSeries to seriesXxx #34

merged 2 commits into from
Apr 7, 2020

Conversation

tidoust
Copy link
Member

@tidoust tidoust commented Apr 7, 2020

This update renames previousInSeries and nextInSeries to seriesPrevious and seriesNext to improve naming consistency with other series properties, which all start with series.

It seems tempting to put these properties under the series object, but that object is meant to convey information about the series itself, not about the current spec in the series, which seriesComposition, seriesVersion, seriesPrevious and seriesNext hold. In other words, the series object is the same for all specs in the series while other series properties are specific to each one. Or should we not care and put everything under series (but then that would be inconsistent with the W3C API)?

This update renames `previousInSeries` and `nextInSeries` to `seriesPrevious`
and `seriesNext` to improve naming consistency with other series properties,
which all start with `series`.

Note: it is tempting to put these properties under the `series` object, but that
object is meant to convey information about the series itself, not about the
current spec in the series, which `seriesComposition`, `seriesVersion`,
`seriesPrevious` and `seriesNext` hold. In other words, the `series` object is
the same for all specs in the series.
@tidoust tidoust requested a review from dontcallmedom April 7, 2020 12:32
@tidoust tidoust merged commit 338bad1 into w3c:master Apr 7, 2020
@tidoust tidoust deleted the series branch May 7, 2020 06:47
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.

2 participants