Open
Description
openedon May 16, 2023
As mentioned here, there's some consistency issues with the non-normative parts of the spec. It would be great to get a thorough review of this. These proposed fixes are all editorial, not functional.
Examples of ways we can improve:
- consistent use of
monospace
to refer to types and glossary terms (adding more glossary terms if necessary) - Consistent language examples: some examples are
typescript
others arejava
. I think unless the requirement specifically demands a particular language, we use choose one example language, or a consistent pseudo-code. I recommend Java because it's explicit, typed, and generally well-understood. - consistent reference to types with spaces and in lower-case as described in the style guide (ex:
flag metadata
notflagMetadata
) - consistent links in non-normative text (link anything relevant)
- Consistent diagrams (I vote we use mermaid for everything). We have diagrams in the provider and hooks sections that are not mermaid.
- Consistent pluralization: now that there's multiple providers, we need to update some language which implies there's only one. This will impact normative sections, but not in a meaningful or breaking way.
cc @tcarrio
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment