Skip to content

Commit

Permalink
Merge pull request #159 from w3ctag/atanassov-naming
Browse files Browse the repository at this point in the history
Adding API naming, language and charset advise addressing feedback in #108
  • Loading branch information
atanassov authored Mar 17, 2020
2 parents 82dea71 + b3e9163 commit 68b84b3
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,13 @@ and by name association.

Please consult widely on names in your APIs.

API naming *must* be done in easily readable US English. For example `horizontalAlignment`
is a more English-readable name than `alignmentHorizontal`. Whenever possible consider
readability over brevity.

Names should adhere to the local language restrictions, for example CSS ident rules etc.
and *should* be in the [ASCII range](https://infra.spec.whatwg.org/#ascii-code-point).

Boolean properties, options, or API parameters which are asking a question about
their argument *should not* be prefixed with <code>is</code>, while methods
that serve the same purpose, given that it has no side effects, *should* be
Expand Down

0 comments on commit 68b84b3

Please sign in to comment.