Skip to content

Commit

Permalink
Apply "options extensibility" language improvements
Browse files Browse the repository at this point in the history
Improvement suggestions from Ted and Dave in PR feedback

Co-authored-by: Dave Longley <[email protected]>
Co-authored-by: Ted Thibodeau Jr <[email protected]>
  • Loading branch information
3 people authored Dec 15, 2024
1 parent 023abf6 commit 8199b0c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,17 +693,17 @@ <h3>Options</h3>
</p>
<h4>Options Extensibility</h4>
<p>
Implementations may extend an `options` object with additional properties.
Property keys may be any string but they should be appropriately namespaced (for example by using URIs)
Implementations MAY extend an `options` object with additional properties.
Property keys can be any string but they should be appropriately namespaced (for example by using URIs)
in order to avoid collisions with extensions in other implementations.
</p>
<p>
As extension properties are implementation specific, they should not be mandatory.
As extension properties are implementation specific, they ought not be mandatory.
This is to maintain interoperability by avoiding clients needing to be modified to use a specific implementation.
</p>
<p>
When adding an extension `options` property, consider if providing optionality to clients is necessary.
If not, using instance configuration to vary API functionality may be a preferable approach.
When adding an extension `options` property, consider whether providing optionality to clients is necessary.
If not, using instance configuration to vary API functionality might be a preferable approach.
</p>
</section>
<section>
Expand Down

0 comments on commit 8199b0c

Please sign in to comment.