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.

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

Change language "will be" to "is" #27

Open
kleihan opened this issue Apr 16, 2021 · 1 comment
Open

Change language "will be" to "is" #27

kleihan opened this issue Apr 16, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation Version 1.2 RC2

Comments

@kleihan
Copy link
Member

kleihan commented Apr 16, 2021

Many places in the spec use future tense (will...)to talk about how certain commands will show after rendering. Should ir rather be present tense in a normative specification?

  • FROM: For example to indicate that tag 25009 will be used to ...
  • TO: For example to indicate that tag 25009 is used to ...
@donmendelson
Copy link
Member

In a specification, language should be imperative rather than descriptive. In other words, it should say what an implementation should do to conform to the standard. An absolute requirement should be expressed like "tag 25009 must be used" or "should be used". If the behavior is optional or recommended, then say "tag 25009 may be used to..."

@kleihan kleihan added documentation Improvements or additions to documentation Version 1.2 RC2 labels Apr 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Version 1.2 RC2
Projects
None yet
Development

No branches or pull requests

2 participants