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

Final revisions before next draft #108

Closed
4 tasks done
kevinmpowell opened this issue Jan 25, 2022 · 8 comments
Closed
4 tasks done

Final revisions before next draft #108

kevinmpowell opened this issue Jan 25, 2022 · 8 comments
Labels
dtcg-format All issues related to the format specification.

Comments

@kevinmpowell
Copy link
Contributor

kevinmpowell commented Jan 25, 2022

  • camelCase consistency on all spec properties, values and sub-value names. Example: "cubic-bezier" should be "cubicBezier"
  • Add clarification on group property inheritance ($type is inherited, $description is not)
  • Round of review from all editors prior to publishing
  • Update all format properties with a $ prefix. For example type becomes $type
@kevinmpowell kevinmpowell added this to the Next Review Cycle milestone Jan 25, 2022
@c1rrus
Copy link
Member

c1rrus commented Feb 2, 2022

I think we should also include an update to prefix all format properties with $ (e.g. type --> $type).

@kevinmpowell
Copy link
Contributor Author

@c1rrus I've updated the main checklist to reflect that change.

@c1rrus
Copy link
Member

c1rrus commented Feb 3, 2022

Cool, thanks

@c1rrus
Copy link
Member

c1rrus commented Feb 6, 2022

I've opened PR #111 to take care of the $ prefix and camelCase stuff.

Re-reading the spec, I think it's already quite clear that, when set on a group, $type is inherited and $description is not. I'm not sure if we need to add any additional clarification.

@drwpow
Copy link

drwpow commented Feb 9, 2022

A general question/possible opportunity for clarification (also forgive me if this has been answered elsewhere): with #111, the $ prefix was added to groups to distinguish between group properties vs subgroups/tokens. And $ was added to tokens as well for parity (correct?).

In that case, does the spec allow any non-$ properties on tokens, or are those simply ignored? And if the latter are non-$ properties on tokens the recommended approach for arbitrary metadata?

(pending resolution of #97, which would obviously change this)

@c1rrus
Copy link
Member

c1rrus commented Feb 16, 2022

In that case, does the spec allow any non-$ properties on tokens, or are those simply ignored? And if the latter are non-$ properties on tokens the recommended approach for arbitrary metadata?

As it stands (and perhaps this should be clarified in the spec's wording), additional props on tokens are not allowed.

The $extensions property is the place where teams and tools can store additional, proprietary data associated with a token.

@kaelig kaelig added the dtcg-format All issues related to the format specification. label Mar 8, 2022
@c1rrus
Copy link
Member

c1rrus commented Apr 5, 2022

Add clarification on group property inheritance ($type is inherited, $description is not)

Editors' decision on 5. April: Will leave as is for now, but in later (working?) drafts we may re-arrange chapters and add more details about what properties apply to and whether or not they are inherited in a more standardised way.

@c1rrus
Copy link
Member

c1rrus commented Jun 13, 2022

All items in the todo list have now been addressed, so closing this issue.

@c1rrus c1rrus closed this as completed Jun 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dtcg-format All issues related to the format specification.
Projects
None yet
Development

No branches or pull requests

4 participants