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

Editorial suggestions from Najib #7

r12a opened this issue Aug 2, 2017 · 1 comment

Editorial suggestions from Najib #7

r12a opened this issue Aug 2, 2017 · 1 comment


Copy link

@r12a r12a commented Aug 2, 2017

  • Producer and consumer are used in a well defined way (section2). These terms are encountered two times earlier in §1.1, and even if the context is clear, I think it's better to indicate there that these words will be well defined later (section 2 in this case).

  • §1.1, 2nd paragraph after the JSON example,
    "[..] For each of the fields containing natural language text [..] there will be a language attribute and base direction stored as metadata [..]
    "These data fields are used in a variety of ways [..]
    I understand "These metadata are used ...". The wording "data fields" may create an ambiguity with the JSON fields containing text.
    Besides, you say "the data structure provides no place to store these [i.e. metadata]."

  • Last paragraph before §1.2

"They [producer and consumer] may have other considerations, such as field length, that are affected by the insertion of additional controls or markup".
Or (among "other considerations") the fact that those controls may use different escape sequence, e.g. ‎ instead of \u200e.
(Your example : "authors": [ "\u200eHerman Melville" ], // contains LRM as first character)

  • §2.1 1st para.

"a dedicated system with an interface that allows base direction to be specified during input "
s/allows/asks for/
"if you are lucky" an input interface will ask you to specify the direction of the string you type. If it allows only, you may not specify it. Unless there is a default, but it may not be what user wants.

  • 2nd para.
    "When a string is created, it's necessary to [..] take steps [..] to set the string up in a way that communicates the language/base direction."
    Would add "that ALSO communicates the language/base direction."

  • §2.3 "Decoding information", is in relation with §4.2 "The main issue"
    In 4.2, "The main issue is how a consumer of a string will know what base direction should be used for that string". I understand if this base direction is not communicated with the string.

If my understanding is correct, I suggest to add something like "See §4.2", at the end of the sentence "Even if no action is taken by the producer, the consumer must decide what rules to follow in order to decide on the appropriate base direction/language." in section 2.3 "Decoding information". Indeed, this section is about to decode the [producer] information since "the consumer of the string [has to] understand how the producer did". So, the sentence might seem a little out of context.

aphillips added a commit that referenced this issue Aug 2, 2017

This comment has been minimized.

Copy link

@aphillips aphillips commented Aug 2, 2017

Please see the above commit. I think I have addressed all of the above. Please advise if I've missed anything.

@aphillips aphillips added the close? label Feb 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.