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

Delete unnecessary Conventions attribute in two examples #349

Closed
JonathanGregory opened this issue Jan 10, 2022 · 5 comments · Fixed by #350
Closed

Delete unnecessary Conventions attribute in two examples #349

JonathanGregory opened this issue Jan 10, 2022 · 5 comments · Fixed by #350
Assignees
Labels
change agreed Issue accepted for inclusion in the next version and closed defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors

Comments

@JonathanGregory
Copy link
Contributor

JonathanGregory commented Jan 10, 2022

Linked pull request

Dear all

I propose the deletion of the Conventions attribute from Examples 7.15 and 7.16 in Section 7.5 on Geometries. Although it may seem odd to delete information, I think the attribute here isn't really informative. Including it is a defect, and removing it is a correction. My reasons for thinking this are:

  • These are the only examples in the whole document that contain the Conventions attribute (as has been discussed elsewhere), so it's inconsistent. We couldn't make the document consistent by including Conventions in all other examples, because most of them are just fragments of CDL. They don't show global attributes, which would be irrelevant and hence distracting to the point being illustrated.

  • Keeping Conventions only in these two examples might imply it was particularly significant, more than in all other examples which don't include it. This isn't so. I guess that it might have been included to make the point, at the time the proposal was drafted, that the feature didn't exist in the version that was the present release at that time. Maybe @dblodgett can remember?

Best wishes

Jonathan

@JonathanGregory JonathanGregory added the defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors label Jan 10, 2022
@erget
Copy link
Member

erget commented Jan 10, 2022

@JonathanGregory I support this proposal, examples are most illustrative when they contain the minimal material to demonstrate what they're about. In that context the Conventions attribute is a distraction requiring additional maintenance.

@taylor13
Copy link

I support this proposal too (for the same reasons).

@davidhassell
Copy link
Contributor

I support this as well.

@JonathanGregory
Copy link
Contributor Author

Thank you all for supporting this. I have created a pull request, which can be merged in three weeks from now (since this is a defect issue) on 1st February, if no-one objects before then. Jonathan

@JonathanGregory
Copy link
Contributor Author

This is a defect and no-one has objected, so the pull request could be merged today. Please could someone oblige? Thanks.

@erget erget self-assigned this Feb 1, 2022
@erget erget linked a pull request Feb 1, 2022 that will close this issue
@erget erget closed this as completed in #350 Feb 1, 2022
@JonathanGregory JonathanGregory added the change agreed Issue accepted for inclusion in the next version and closed label Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
change agreed Issue accepted for inclusion in the next version and closed defect Conventions text meaning not as intended, misleading, unclear, has typos, format or language errors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants