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.

Sign up for GitHub

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

Jump to bottom

expand on consistency of naming #149

Closed
dbaron opened this issue Dec 16, 2019 · 6 comments · Fixed by #163
Closed

expand on consistency of naming #149

dbaron opened this issue Dec 16, 2019 · 6 comments · Fixed by #163
Assignees
@cynthia @alice @atanassov
Milestone
2020-03-30-week

Comments

@dbaron
Copy link
Member

dbaron commented Dec 16, 2019

We have a section on naming but reading the opening comment of w3ctag/design-reviews#341 it seems like we could expand on the principles around naming consistency a little bit. In particular, names within a set of names (e.g., the values of an attribute/property/feature/etc.) should be:

  • consistent in terms of parts of speech (noun, verb, adjective, etc.)
  • consistent in negation (e.g., either all of the names in a set should describe what is allowed or they should all describe what is denied)
  • (probably some more things here)
@plinss plinss added this to the 2020-02-03-week milestone Jan 29, 2020
@alice
Copy link
Contributor

alice commented Jan 29, 2020

Speculatively assigned @cynthia as this harmonises with thoughts on clear language.

@hober
Copy link
Contributor

hober commented Jan 29, 2020

See also w3ctag/design-reviews#429

@alice
Copy link
Contributor

alice commented Jan 29, 2020

and #136

@alice
Copy link
Contributor

alice commented Jan 29, 2020

and #132

@alice
Copy link
Contributor

alice commented Jan 29, 2020

and #108

hober added a commit that referenced this issue Mar 4, 2020
@hober
Attempt to address some of the naming feedback in #132 and #149.
a4636fc
hober added a commit that referenced this issue Mar 17, 2020
@hober
Attempt to address some of the naming feedback in #132 and #149.
1d05662
hober added a commit that referenced this issue Mar 18, 2020
@hober
Attempt to address some of the naming feedback in #132 and #149.
b34a75e
@alice
Copy link
Contributor

alice commented Mar 30, 2020

PR: https://github.com/w3ctag/design-principles/pull/163/files

@dbaron dbaron linked a pull request Mar 30, 2020 that will close this issue
Naming things: expand language around the use of common words, brevity, wide consultation, and future-proofing. #163
Merged
hober added a commit that referenced this issue May 4, 2020
@hober
Attempt to address some of the naming feedback in #132 and #149.
1da4c4a
@torgo torgo closed this as completed in #163 May 6, 2020
torgo pushed a commit that referenced this issue May 6, 2020
@hober
Naming things: expand language around the use of common words, brevit…
c910f19 
…y, wide consultation, and future-proofing. (#163)

Approved in the [call on 6-May-2020](https://github.com/w3ctag/meetings/blob/gh-pages/2020/telcons/05-04-agenda.md)

* Attempt to address some of the naming feedback in #132 and #149.

* Expand the naming consultation advice.

* Expand on readibility v. brevity.

* Add two future-proofing examples.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cynthia cynthia

@alice alice

@atanassov atanassov

Labels
None yet
Projects
None yet
Milestone
2020-03-30-week
6 participants
@hober @cynthia @alice @dbaron @plinss @atanassov