Skip to content

Commit

Permalink
Short is often better (#474)
Browse files Browse the repository at this point in the history
* Short is often better

...not just sometimes

* Update index.bs

Co-authored-by: Theresa O'Connor <hober0@gmail.com>

---------

Co-authored-by: Peter Linss <peter@linss.com>
Co-authored-by: Theresa O'Connor <hober0@gmail.com>
  • Loading branch information
3 people authored Mar 5, 2024
1 parent c28ea64 commit 2aa21c4
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions index.bs
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ Do not assume that a change or removal is impossible without first checking.

<h3 id=removing-features>Remove or change capabilities only once you understand existing usage</h3>

Prioritize compatibility with existing content when removing or changing functionality.
Prioritize compatibility with existing content when removing or changing functionality.

Once a significant amount of content has come to depend on a particular behavior,
removing or changing that behavior is discouraged.
Expand Down Expand Up @@ -3239,8 +3239,8 @@ than `cardinality`.
</div>

Value readability over brevity.
Keep in mind, however, that sometimes
the shorter name is the clearer one.
Keep in mind, however, that
the shorter name is often the clearer one.
For instance,
it may be appropriate to use technical language or well-known terms of art
in the specification where the API is defined.
Expand Down Expand Up @@ -3446,7 +3446,7 @@ initialisms, even if they are repeated.

<h4 id="factory-naming" class="no-num no-toc">Start factory method names with `create` or `from`</h4>

Factory method names should start with `create` or `from`, optionally followed by a more specific noun.
Factory method names should start with `create` or `from`, optionally followed by a more specific noun.

If a factory method constructs a new empty object,
prefix the method name with `create`.
Expand Down

0 comments on commit 2aa21c4

Please sign in to comment.