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

Define icons for actions #62

Closed
wants to merge 2 commits into from
Closed

Define icons for actions #62

wants to merge 2 commits into from

Conversation

mvano
Copy link
Contributor

@mvano mvano commented Jan 28, 2016

This PR adds an icon attribute to NotificationAction, as proposed in #59

example, it may be painted a specific color, corners may be rounded, a drop
shadow may be applied. It is recommended to use an icon design that handles such
modifications gracefully and does not lose important information through e.g.
loss of color or clipped corners.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"may be modified" is a bit ambiguous. What about the following phrasing?

Some platforms may modify an [action item resource] to better match the platform's visual style
before displaying it to the user, for example by adding rounded corners or painting it in a specific
color. It is recommended to use an icon that handles such cases gracefully and does not lose
important information through e.g. loss of color or clipped corners.

It would be great if we could add something among the lines of "TEST!", but it's already quite verbose as-is.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done on rephrasing it a bit.

@beverloo
Copy link
Member

Overall I think this change is good, a few comments. Two more points:

@mvano mvano changed the title Define icons for actions. Define icons for actions Jan 28, 2016
@mvano
Copy link
Contributor Author

mvano commented Jan 28, 2016

I think #28 can be addressed after getting action icons in. I agree that this PR helps motivate addressing it.

@mvano
Copy link
Contributor Author

mvano commented Jan 28, 2016

All done.

@beverloo
Copy link
Member

This looks good to me, also based on the additional data Michael provided in #59. Let's see if we can get some functional feedback from Mozilla.

WDYT @annevk?

<a>action icon resource</a> to better match the platform's visual style before
displaying it to the user, for example by rounding the corners or painting it in
a specific color. It is recommended to use an icon that handles such cases
gracefully and does not lose important information through e.g. loss of color or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There should be a comma before "e.g.".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this and this page explain how this is recommended by some style guides, primarily American ones, it is not usually required. If anything, a comma after is more commonly recommended, and one could even use both one before and after.

Personally, I find commas look unappealing in combination with the periods, and would prefer not to add any.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, maybe that's okay. @sideshowbarker has been asking me to do it, but thus far whenever I ask it of others they don't like it. Maybe we need a WHATWG style guide.

@annevk
Copy link
Member

annevk commented Jan 28, 2016

This seems reasonable to me. Still trying to find some additional folks to review new features, but this is not that big.

@annevk
Copy link
Member

annevk commented Feb 1, 2016

I'll let @sideshowbarker have a look and then probably merge this tomorrow if I don't forget. Feel free to ping me. If you could rebase/squash that'd be appreciated. I'll try to add some Merge advice around the same time.

@sideshowbarker
Copy link

I don’t feel strongly but among that arguments in favor or using comma after e.g. are:

  • it’s never incorrect no matter what style you follow (as opposed to just being seen as unnecessary)
  • it’s the style used in other Web standards (which for consistency with one another mostly follow a convention of using American English style)

So I would prefer that either:

  • if you want to use e.g., it should be followed with a comma, and we also make a practice of consistently using a comma after e.g. in all our specs

  • you avoid the question by instead just writing it out as for example—with a comma after it and before it as needed; for example:

    and does not lose important information through, for example, loss of color

Incidentally when it’s written out as for example I think the purpose of the comma(s) is clear—in that, you wouldn’t write the above as:

and does not lose important information through for example loss of color

@mvano
Copy link
Contributor Author

mvano commented Feb 1, 2016

Incidentally when it’s written out as for example I think the purpose of the comma(s) is clear

Oh the purpose is clear. But to me, "e.g." just expands to ", for example," with the commas included, as visually it looks similar enough with the periods.

Anyway, I'm not the editor of this spec, so if consensus is to insist on the commas just let me know whether to add one before, after, or both.

annevk pushed a commit that referenced this pull request Feb 2, 2016
@annevk
Copy link
Member

annevk commented Feb 2, 2016

Committed as 362780b with gratuitous use of commas.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants