Use "calendar" attribute in examples

[pvanlaake]

Use the "calendar" attribute in examples

Moderator

not assigned

Requirement Summary

The "calendar" attribute is recommended for time coordinate variables. There are several examples, however, where the time coordinate variable does not have that attribute.

Technical Proposal Summary

Add the "calendar" attribute where relevant.

Benefits

Consistency in applying recommendations.

Status Quo

Examples 5.1, 5.7, 5.14, 5.15, 5.17, ...

Associated pull request

#641

[JonathanGregory]

Thank you, Patrick @pvanlaake. I agree with this proposal, and I think it's fine to address as a defect.

[taylor13]

I don't object to the proposed change, but aren't there a number of examples where we've left out recommended attributes (even required ones?) just to focus on the particular attribute being discussed? We do this in example 3.4, but we also note that we've simplified the example by omitting certain attributes.

Let's go ahead and clean up calendar, if the consensus is that this is desirable; we can perhaps later undertake a comprehensive review to see if there are other attributes that have been left out for simplicity and decide whether we should in fact include them.

[JonathanGregory]

@taylor13. I think the point is that calendar is recommended for time coordinate variables, and not following recommendations sets a bad example. That's different from omitting attributes which are optional or irrelevant, which helps to keep examples simple.

[ChrisBarker-NOAA]

I think the point is that calendar is recommended for time coordinate variables, and not following recommendations sets a bad example.

I agree wholeheartedly -- a LOT of people follow examples rather than reading the spec -- the examples should be best practices to the extent practicable.

Thanks @pvanlaake!

NOTE: while we are looking at time examples, it might be time to revive this effort of mine:

#557

The discussion is:

https://github.com/orgs/cf-convention/discussions/383

I've just started #626 to revive that.

[pvanlaake]

Noting no objections, I propose that the "calendar" attribute is added consistently in all examples. I also propose to make a single PR together with the related #624.

[JonathanGregory]

As you say, Patrick, no objections were raised to this defect remedy. It is therefore accepted. Thanks for doing the PR.