commenter 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.github/workflows/rake.yml +15 -0
- data/.github/workflows/release.yml +25 -0
- data/.gitignore +12 -0
- data/.rspec +3 -0
- data/.rubocop.yml +8 -0
- data/CODE_OF_CONDUCT.md +132 -0
- data/Gemfile +12 -0
- data/README.adoc +284 -0
- data/Rakefile +12 -0
- data/commenter.gemspec +35 -0
- data/comments.yaml +687 -0
- data/data/iso_comment_template_2012-03.docx +0 -0
- data/exe/commenter +7 -0
- data/lib/commenter/cli.rb +82 -0
- data/lib/commenter/comment.rb +89 -0
- data/lib/commenter/comment_sheet.rb +71 -0
- data/lib/commenter/filler.rb +107 -0
- data/lib/commenter/parser.rb +101 -0
- data/lib/commenter/version.rb +5 -0
- data/lib/commenter.rb +11 -0
- data/schema/iso_comment_2012-03.yaml +69 -0
- data/sig/commenter.rbs +4 -0
- data/spec/commenter_spec.rb +8 -0
- data/spec/spec_helper.rb +15 -0
- metadata +100 -0
data/comments.yaml
ADDED
@@ -0,0 +1,687 @@
|
|
1
|
+
# yaml-language-server: $schema=schema/iso_comment_2012-03.yaml
|
2
|
+
|
3
|
+
---
|
4
|
+
version: 2012-03
|
5
|
+
comments:
|
6
|
+
- id: DE-002
|
7
|
+
body: DE
|
8
|
+
locality:
|
9
|
+
line_number:
|
10
|
+
clause: '5'
|
11
|
+
element: 2-5.7,4th column
|
12
|
+
type: te
|
13
|
+
comments: The ser A should be mentioned for unique existential quantifiers too.
|
14
|
+
proposed_change: Add “∈A” in the formula between “x” and “p(x)”
|
15
|
+
observations: Accepted.
|
16
|
+
- id: DE-003
|
17
|
+
body: DE
|
18
|
+
locality:
|
19
|
+
line_number:
|
20
|
+
clause: '6'
|
21
|
+
element: 2-6.6,4th column
|
22
|
+
type: te
|
23
|
+
comments: The empty set should be explained.
|
24
|
+
proposed_change: Add e.g “There is no element belonging to the empty set.”
|
25
|
+
observations: Accepted. Now “An empty set contains no elements.”
|
26
|
+
- id: DE-004
|
27
|
+
body: DE
|
28
|
+
locality:
|
29
|
+
line_number:
|
30
|
+
clause: '6'
|
31
|
+
element: 2-6.15,4th column
|
32
|
+
type: te
|
33
|
+
comments: The properties of ordered n-tuples should be described separately.
|
34
|
+
proposed_change: ''
|
35
|
+
observations: Clarification needed.
|
36
|
+
- id: DE-005
|
37
|
+
body: DE
|
38
|
+
locality:
|
39
|
+
line_number:
|
40
|
+
clause: '8'
|
41
|
+
element: 2-8.8,4th column
|
42
|
+
type: te
|
43
|
+
comments: Hints to explain the notions “congruence” and “isomorphism” should be
|
44
|
+
included.
|
45
|
+
proposed_change: ''
|
46
|
+
observations: Accepted.
|
47
|
+
- id: DE-006
|
48
|
+
body: DE
|
49
|
+
locality:
|
50
|
+
line_number:
|
51
|
+
clause: '8'
|
52
|
+
element: 2-8.15,4th column
|
53
|
+
type: te
|
54
|
+
comments: The distinction between “” and “” should be explained.
|
55
|
+
proposed_change: ''
|
56
|
+
observations: Accepted.
|
57
|
+
- id: DE-007
|
58
|
+
body: DE
|
59
|
+
locality:
|
60
|
+
line_number:
|
61
|
+
clause: '8'
|
62
|
+
element: 2-8.19,2nd column,4th column
|
63
|
+
type: te
|
64
|
+
comments: The expressions “a+b” should be replaced by a more general form.
|
65
|
+
proposed_change: ''
|
66
|
+
observations: Clarification needed.
|
67
|
+
- id: DE-008
|
68
|
+
body: DE
|
69
|
+
locality:
|
70
|
+
line_number:
|
71
|
+
clause: '8'
|
72
|
+
element: 2-9.3;4th column
|
73
|
+
type: te
|
74
|
+
comments: The notion “rotation angle” is not mentioned in ISO 80000-3.
|
75
|
+
proposed_change: The remark should be reformulated.
|
76
|
+
observations: 'Accepted. The text is added: “For oriented or rotation angles, the
|
77
|
+
angle stem:[∢ "ABC"] measures the rotation from ray "BA" to ray "BC" and
|
78
|
+
can be positive (counterclockwise) or negative (clockwise). For oriented angles,
|
79
|
+
stem:[∢ "ABC" != ∢ "CBA"] and stem:[-2pi < ∢ "ABC" <= 2pi
|
80
|
+
"unitsml(rad)"], with the conventional range being stem:[-pi < ∢ "ABC"
|
81
|
+
<= pi "unitsml(rad)"]. The non-oriented angle corresponds to the absolute value
|
82
|
+
or smallest positive representation of the oriented angle.”'
|
83
|
+
- id: DE-009
|
84
|
+
body: DE
|
85
|
+
locality:
|
86
|
+
line_number:
|
87
|
+
clause: '10'
|
88
|
+
element: 2-10.16,3rd column
|
89
|
+
type: te
|
90
|
+
comments: The symbol “|a|” is defined for real numbers a.
|
91
|
+
proposed_change: Add “the real number” after “absolute value of”.
|
92
|
+
observations: Accepted.
|
93
|
+
- id: DE-010
|
94
|
+
body: DE
|
95
|
+
locality:
|
96
|
+
line_number:
|
97
|
+
clause: '10'
|
98
|
+
element: 2-10.21,3rd column
|
99
|
+
type: te
|
100
|
+
comments: The symbol “min(a,b)” is defined for real numbers a and b.
|
101
|
+
proposed_change: Add “the real numbers” after “minimum of”.
|
102
|
+
observations: Accepted.
|
103
|
+
- id: DE-011
|
104
|
+
body: DE
|
105
|
+
locality:
|
106
|
+
line_number:
|
107
|
+
clause: '10'
|
108
|
+
element: 2-10.22,3rd column
|
109
|
+
type: te
|
110
|
+
comments: The symbol “max(a,b)” is defined for real numbers a and b.
|
111
|
+
proposed_change: Add “the real numbers” after “maximum of”.
|
112
|
+
observations: Accepted.
|
113
|
+
- id: DE-012
|
114
|
+
body: DE
|
115
|
+
locality:
|
116
|
+
line_number:
|
117
|
+
clause: '11'
|
118
|
+
element: 2-11.1,4th column
|
119
|
+
type: te
|
120
|
+
comments: Factorials are defined for natural numbers or 0.
|
121
|
+
proposed_change: Add “natural numbers” after “for”.
|
122
|
+
observations: Accepted.
|
123
|
+
- id: DE-013
|
124
|
+
body: DE
|
125
|
+
locality:
|
126
|
+
line_number:
|
127
|
+
clause: '11'
|
128
|
+
element: 2-11.2,4th column
|
129
|
+
type: te
|
130
|
+
comments: Falling factorials are defined for natural numbers and for 0.
|
131
|
+
proposed_change: Add “natural numbers” after “for”.
|
132
|
+
observations: Accepted.
|
133
|
+
- id: DE-014
|
134
|
+
body: DE
|
135
|
+
locality:
|
136
|
+
line_number:
|
137
|
+
clause: '11'
|
138
|
+
element: 2-11.3,4th column
|
139
|
+
type: te
|
140
|
+
comments: Rising factorials are defined for natural numbers and for 0.
|
141
|
+
proposed_change: Add “natural numbers” after “for”.
|
142
|
+
observations: Accepted.
|
143
|
+
- id: DE-015
|
144
|
+
body: DE
|
145
|
+
locality:
|
146
|
+
line_number:
|
147
|
+
clause: '11'
|
148
|
+
element: 2-11.4,4th column
|
149
|
+
type: te
|
150
|
+
comments: Binomial coefficients are defined for natural numbers and for 0.
|
151
|
+
proposed_change: Add “natural numbers” after “for”.
|
152
|
+
observations: Accepted.
|
153
|
+
- id: DE-016
|
154
|
+
body: DE
|
155
|
+
locality:
|
156
|
+
line_number:
|
157
|
+
clause: '11'
|
158
|
+
element: 2-11.5,4th column
|
159
|
+
type: te
|
160
|
+
comments: The Bernoulli numbers are defined for natural numbers and for 0.
|
161
|
+
proposed_change: Add “natural numbers” after “for”.
|
162
|
+
observations: Accepted.
|
163
|
+
- id: DE-017
|
164
|
+
body: DE
|
165
|
+
locality:
|
166
|
+
line_number:
|
167
|
+
clause: '11'
|
168
|
+
element: 2-11.8,4th column
|
169
|
+
type: te
|
170
|
+
comments: The number of variations without repetitions is defined for natural numbers 0
|
171
|
+
≤ k ≤ n .
|
172
|
+
proposed_change: Add “(for 0 ≤ k ≤ n )” after the formula.
|
173
|
+
observations: Accepted.
|
174
|
+
- id: DE-018
|
175
|
+
body: DE
|
176
|
+
locality:
|
177
|
+
line_number:
|
178
|
+
clause: '11'
|
179
|
+
element: 2-11.9,4th column
|
180
|
+
type: te
|
181
|
+
comments: The number of variations without repetitions is defined for natural numbers
|
182
|
+
k and n.
|
183
|
+
proposed_change: Add “(for natural numbers k and n )” after the formula.
|
184
|
+
observations: Accepted.
|
185
|
+
- id: DE-019
|
186
|
+
body: DE
|
187
|
+
locality:
|
188
|
+
line_number:
|
189
|
+
clause: '12'
|
190
|
+
element: 2-12.6,2nd column
|
191
|
+
type: te
|
192
|
+
comments: The word “surjectively” may be dropped.
|
193
|
+
proposed_change: Add “f maps A onto B” on a new line.
|
194
|
+
observations: Accepted.
|
195
|
+
- id: DE-020
|
196
|
+
body: DE
|
197
|
+
locality:
|
198
|
+
line_number:
|
199
|
+
clause: '12'
|
200
|
+
element: 2-12.6,4th column
|
201
|
+
type: te
|
202
|
+
comments: The notion “surjective” should be introduced.
|
203
|
+
proposed_change: Add “The function f is then said to be surjective.”
|
204
|
+
observations: Accepted.
|
205
|
+
- id: DE-021
|
206
|
+
body: DE
|
207
|
+
locality:
|
208
|
+
line_number:
|
209
|
+
clause: '12'
|
210
|
+
element: 2-12.8,4th column
|
211
|
+
type: te
|
212
|
+
comments: The notion “bijective” should be introduced.
|
213
|
+
proposed_change: Add “The function f is then said to be bijective.”
|
214
|
+
observations: Accepted.
|
215
|
+
- id: DE-022
|
216
|
+
body: DE
|
217
|
+
locality:
|
218
|
+
line_number:
|
219
|
+
clause: '12'
|
220
|
+
element: 2-12.9,2nd column
|
221
|
+
type: te
|
222
|
+
comments: The expression should be surrounded by angle brackets to clarify that
|
223
|
+
this is a single expression, and a comma as separator. A link to the notion “prime
|
224
|
+
number” should be included.
|
225
|
+
proposed_change: Replace by .
|
226
|
+
observations: Accepted. An example of a mapping to a prime number is now provided.
|
227
|
+
- id: DE-023
|
228
|
+
body: DE
|
229
|
+
locality:
|
230
|
+
line_number:
|
231
|
+
clause: '13'
|
232
|
+
element: 2-13.1,4th column
|
233
|
+
type: te
|
234
|
+
comments: The Euler number is not periodic, but the given representation suggest
|
235
|
+
the false equality e = 2,7182818281828… .
|
236
|
+
proposed_change: Add the comment “The decimal digits of the Euler number have no
|
237
|
+
periodic repetitions because it is not a rational number.)”
|
238
|
+
observations: Accepted.
|
239
|
+
- id: DE-024
|
240
|
+
body: DE
|
241
|
+
locality:
|
242
|
+
line_number:
|
243
|
+
clause: '14'
|
244
|
+
element: 2-14.4,4th column
|
245
|
+
type: te
|
246
|
+
comments: The tangent of is not defined whenever for .
|
247
|
+
proposed_change: Add:for .
|
248
|
+
observations: Accepted.
|
249
|
+
- id: DE-025
|
250
|
+
body: DE
|
251
|
+
locality:
|
252
|
+
line_number:
|
253
|
+
clause: '14'
|
254
|
+
element: 2-14.5,4th column
|
255
|
+
type: te
|
256
|
+
comments: The cotangent of x is not defined whenever for
|
257
|
+
proposed_change: Add:.
|
258
|
+
observations: Accepted.
|
259
|
+
- id: DE-026
|
260
|
+
body: DE
|
261
|
+
locality:
|
262
|
+
line_number:
|
263
|
+
clause: '14'
|
264
|
+
element: 2-14.6,4th column
|
265
|
+
type: te
|
266
|
+
comments: The secant of is not defined whenever for
|
267
|
+
proposed_change: Add:for .
|
268
|
+
observations: Accepted.
|
269
|
+
- id: DE-027
|
270
|
+
body: DE
|
271
|
+
locality:
|
272
|
+
line_number:
|
273
|
+
clause: '14'
|
274
|
+
element: 2-14.7,4th column
|
275
|
+
type: te
|
276
|
+
comments: The cosecant of is not defined whenever for
|
277
|
+
proposed_change: Add:.
|
278
|
+
observations: Accepted.
|
279
|
+
- id: DE-028
|
280
|
+
body: DE
|
281
|
+
locality:
|
282
|
+
line_number:
|
283
|
+
clause: '14'
|
284
|
+
element: 2-14.8,4th column
|
285
|
+
type: te
|
286
|
+
comments: The arcus sine of is defined only if -1 ≤ x ≤ 1 .
|
287
|
+
proposed_change: Add “-1 ≤ x ≤ 1 and“ after “for”.
|
288
|
+
observations: Accepted.
|
289
|
+
- id: DE-029
|
290
|
+
body: DE
|
291
|
+
locality:
|
292
|
+
line_number:
|
293
|
+
clause: '14'
|
294
|
+
element: 2-14.9,4th column
|
295
|
+
type: te
|
296
|
+
comments: The arcus cosine of x is defined only if -1 ≤ x ≤ 1 .
|
297
|
+
proposed_change: Add “-1 ≤ x ≤ 1 and“ after “for”.
|
298
|
+
observations: Accepted.
|
299
|
+
- id: DE-030
|
300
|
+
body: DE
|
301
|
+
locality:
|
302
|
+
line_number:
|
303
|
+
clause: '14'
|
304
|
+
element: 2-14.10,4th column
|
305
|
+
type: te
|
306
|
+
comments: The values or are impossible for arcus tangent.
|
307
|
+
proposed_change: Replace with
|
308
|
+
observations: Accepted.
|
309
|
+
- id: DE-031
|
310
|
+
body: DE
|
311
|
+
locality:
|
312
|
+
line_number:
|
313
|
+
clause: '14'
|
314
|
+
element: 2-14.11,4th column
|
315
|
+
type: te
|
316
|
+
comments: The arguments and are not allowed for arcus cotangent.
|
317
|
+
proposed_change: Replace with
|
318
|
+
observations: Accepted.
|
319
|
+
- id: DE-032
|
320
|
+
body: DE
|
321
|
+
locality:
|
322
|
+
line_number:
|
323
|
+
clause: '14'
|
324
|
+
element: 2-14.12,4th column
|
325
|
+
type: te
|
326
|
+
comments: The arcus secant of x is defined only if x ≤ -1 or x ≥ 1 .
|
327
|
+
proposed_change: Add “x ≤ -1 or x ≥ 1 and” after “for.
|
328
|
+
observations: Accepted.
|
329
|
+
- id: DE-033
|
330
|
+
body: DE
|
331
|
+
locality:
|
332
|
+
line_number:
|
333
|
+
clause: '14'
|
334
|
+
element: 2-14.13,4th column
|
335
|
+
type: te
|
336
|
+
comments: The arcus cosecant of x is defined only if x ≤ -1 or x ≥ 1 .
|
337
|
+
proposed_change: Add “x ≤ -1 or x ≥ 1 and” after “for.
|
338
|
+
observations: Accepted.
|
339
|
+
- id: DE-034
|
340
|
+
body: DE
|
341
|
+
locality:
|
342
|
+
line_number:
|
343
|
+
clause: '14'
|
344
|
+
element: 2-14.17,4th column
|
345
|
+
type: te
|
346
|
+
comments: The hyperbolic cotangent of x is defined only if .
|
347
|
+
proposed_change: Add “(for )“.
|
348
|
+
observations: Accepted.
|
349
|
+
- id: DE-035
|
350
|
+
body: DE
|
351
|
+
locality:
|
352
|
+
line_number:
|
353
|
+
clause: '14'
|
354
|
+
element: 2-14.19,4th column
|
355
|
+
type: te
|
356
|
+
comments: The hyperbolic cosecant of x is defined only if .
|
357
|
+
proposed_change: Add “(for )“.
|
358
|
+
observations: Accepted.
|
359
|
+
- id: DE-036
|
360
|
+
body: DE
|
361
|
+
locality:
|
362
|
+
line_number:
|
363
|
+
clause: '14'
|
364
|
+
element: 2-14.21,4th column
|
365
|
+
type: te
|
366
|
+
comments: The area hyperbolic cosine of x is defined only if x ≥ 1 .
|
367
|
+
proposed_change: Add “x ≥ 1 and“ after “for”.
|
368
|
+
observations: Accepted.
|
369
|
+
- id: DE-037
|
370
|
+
body: DE
|
371
|
+
locality:
|
372
|
+
line_number:
|
373
|
+
clause: '14'
|
374
|
+
element: 2-14.22,4th column
|
375
|
+
type: te
|
376
|
+
comments: The area hyperbolic tangent of x is defined only if -1 < x < 1 .
|
377
|
+
proposed_change: Add “(for -1 < x < 1 )”.
|
378
|
+
observations: Accepted.
|
379
|
+
- id: DE-038
|
380
|
+
body: DE
|
381
|
+
locality:
|
382
|
+
line_number:
|
383
|
+
clause: '14'
|
384
|
+
element: 2-14.23,4th column
|
385
|
+
type: te
|
386
|
+
comments: The area hyperbolic cotangent of x is defined only if x ≤ -1 or x ≥
|
387
|
+
1 .
|
388
|
+
proposed_change: Add “x ≤ -1 or x ≥ 1 and“ after “for”.
|
389
|
+
observations: Accepted.
|
390
|
+
- id: DE-039
|
391
|
+
body: DE
|
392
|
+
locality:
|
393
|
+
line_number:
|
394
|
+
clause: '14'
|
395
|
+
element: 2-14.24,4th column
|
396
|
+
type: te
|
397
|
+
comments: The area hyperbolic secant of x is defined only if 0 < x ≤ 1 .
|
398
|
+
proposed_change: Add “0 < x ≤ 1 and“ after “for”.
|
399
|
+
observations: Accepted.
|
400
|
+
- id: DE-040
|
401
|
+
body: DE
|
402
|
+
locality:
|
403
|
+
line_number:
|
404
|
+
clause: '14'
|
405
|
+
element: 2-14.25,4th column
|
406
|
+
type: te
|
407
|
+
comments: The area hyperbolic cosecant of x is defined only if .
|
408
|
+
proposed_change: Add “ and“ after “for”.
|
409
|
+
observations: Accepted.
|
410
|
+
- id: DE-041
|
411
|
+
body: DE
|
412
|
+
locality:
|
413
|
+
line_number:
|
414
|
+
clause: '16'
|
415
|
+
element: 2-16.1,4th column
|
416
|
+
type: te
|
417
|
+
comments: The notion “square matrix” should be defined which is used in 2-16.5.
|
418
|
+
proposed_change: Add “For a square matrix the number of rows equals the number of
|
419
|
+
columns.” or an equivalent definition.
|
420
|
+
observations: Accepted.
|
421
|
+
- id: PL-042
|
422
|
+
body: PL
|
423
|
+
locality:
|
424
|
+
line_number:
|
425
|
+
clause: Bibliography
|
426
|
+
element:
|
427
|
+
type: ed
|
428
|
+
comments: 'Instead of ISO 80000-3:2006 "Quantities and units – Part 3: Space and
|
429
|
+
time" should be used as normative reference ISO 80000-3:2019 "Quantities and units
|
430
|
+
– Part 3: Space and time".'
|
431
|
+
proposed_change: ''
|
432
|
+
observations: Accepted.
|
433
|
+
- id: CC-01-043
|
434
|
+
body: CC
|
435
|
+
locality:
|
436
|
+
line_number:
|
437
|
+
clause: Item 2-13.1
|
438
|
+
element:
|
439
|
+
type: ed
|
440
|
+
comments: The number “2,718 81 28” is not correctly formatted with the numeric grouping
|
441
|
+
practice of 3 digits as described in ISO DIR 2. It should have been “2,718 812
|
442
|
+
8”.
|
443
|
+
proposed_change: The correct numeric format is shown with demonstrable usage in
|
444
|
+
Clause 4 “e = 2,718 281 828”.
|
445
|
+
observations: Accepted. Number formatting issue.
|
446
|
+
- id: CC-02-044
|
447
|
+
body: CC
|
448
|
+
locality:
|
449
|
+
line_number:
|
450
|
+
clause: Item 2-17.3
|
451
|
+
element:
|
452
|
+
type: ed
|
453
|
+
comments: Immediately after “sin”, there should be a thin space as per ISO 80000-2,
|
454
|
+
Clause 4 (“there shall be a thin space between the symbol for the function and
|
455
|
+
the argument”). The thin space is verified to be missing in the PDF content tree.
|
456
|
+
proposed_change: Add a thin space after the “sin” function.
|
457
|
+
observations: Accepted. Number formatting issue.
|
458
|
+
- id: CC-03-045
|
459
|
+
body: CC
|
460
|
+
locality:
|
461
|
+
line_number:
|
462
|
+
clause: Item 2-20.7
|
463
|
+
element:
|
464
|
+
type: ed
|
465
|
+
comments: The “sin t” is missing the “thin space” immediately after “sin” (the function
|
466
|
+
name) as required by Clause 4. The thin space is verified to be missing in the
|
467
|
+
PDF content tree.
|
468
|
+
proposed_change: Add a thin space after the “sin” function.
|
469
|
+
observations: Accepted. Number formatting issue.
|
470
|
+
- id: CC-04-046
|
471
|
+
body: CC
|
472
|
+
locality:
|
473
|
+
line_number:
|
474
|
+
clause: Item 2-6.4
|
475
|
+
element:
|
476
|
+
type: ed
|
477
|
+
comments: The last formula under Remarks has a full stop at the end of the formula.
|
478
|
+
This is confusing because it is unclear whether the full stop belongs to the formula,
|
479
|
+
as the formula is not an “inline formula”, but starts off a new line after the
|
480
|
+
colon (“:”).
|
481
|
+
proposed_change: This formula should either be placed inline, or the full stop moved
|
482
|
+
to the next line (or just removed).
|
483
|
+
observations: Accepted. The full stop is removed.
|
484
|
+
- id: CC-05-047
|
485
|
+
body: CC
|
486
|
+
locality:
|
487
|
+
line_number:
|
488
|
+
clause: Clause 18
|
489
|
+
element:
|
490
|
+
type: ed
|
491
|
+
comments: In Clause 18, there are two instances where a bold comma is erroneously
|
492
|
+
used instead of a plain one.
|
493
|
+
proposed_change: Unbold the commas.
|
494
|
+
observations: Accepted.
|
495
|
+
- id: CC-06-048
|
496
|
+
body: CC
|
497
|
+
locality:
|
498
|
+
line_number:
|
499
|
+
clause: Items2-8.42-10.172-10.182-10.12-10.202-12.17
|
500
|
+
element:
|
501
|
+
type: ed
|
502
|
+
comments: ISO DIR 2, 25.3 "Numbering and subdivision” states:"Within a given clause
|
503
|
+
or subclause, examples shall be numbered sequentially. The numbering restarts
|
504
|
+
at each new subdivision. A single example in a subdivision shall not be numbered.”In
|
505
|
+
ISO 80000-2, items 2-8.4, 2-10.17, 2-10.18, 2-10.1, 2-10.20, 2-12.17 all contain
|
506
|
+
an “EXAMPLES” text group that are not numbered sequentially within the item. This
|
507
|
+
seems to be a violation of DIR 2.
|
508
|
+
proposed_change: Split these examples in EXAMPLES into individual sequentially-numbered
|
509
|
+
EXAMPLE 1, EXAMPLE 2, etc.
|
510
|
+
observations: Accepted.
|
511
|
+
- id: CC-07-049
|
512
|
+
body: CC
|
513
|
+
locality:
|
514
|
+
line_number:
|
515
|
+
clause: Item 2-20.21
|
516
|
+
element:
|
517
|
+
type: ed
|
518
|
+
comments: In item 2-20.21, the “narccosz” string is very hard to read due to the
|
519
|
+
lack of spacing. “n” here on first glance looks like part of the function name
|
520
|
+
“arccos”. In Clause 4, it says "Binary operators, for example +, −, /, shall be
|
521
|
+
preceded and followed by thin spaces”. However, for functions, it says “… there
|
522
|
+
shall be a thin space between the symbol for the function and the argument”, without
|
523
|
+
a thin space preceding the function.
|
524
|
+
proposed_change: Perhaps an additional guidance should be given that a thin space
|
525
|
+
needs to precede a function name. For example, if I have a constant called “a”,
|
526
|
+
which is rendered in straight type, and it is placed before “sin x” to indicate
|
527
|
+
multiplication of “a” with “sin x", it would look exactly like “asin x”; but “a
|
528
|
+
sin x” with a preceding space before the function name alleviates the issue.
|
529
|
+
observations:
|
530
|
+
- id: CC-08-050
|
531
|
+
body: CC
|
532
|
+
locality:
|
533
|
+
line_number:
|
534
|
+
clause: Items2-20.262-20.27
|
535
|
+
element:
|
536
|
+
type: ed
|
537
|
+
comments: In 2-20.26 and 2-20.27, there is a conspicuous difference in the rendering
|
538
|
+
of “1/2”, there is a mix of slanted form (in 2-20.26), vertical form (first line
|
539
|
+
in remarks of 2-20.27), and horizontal form (also first line in remarks of 2-20.27).
|
540
|
+
This is very confusing to the reader. The document would benefit from using a
|
541
|
+
consistent fraction style throughout the document, and by also providing guidance
|
542
|
+
on when these 3 different fraction presentation styles can apply. The document
|
543
|
+
today contains an intermix of them, seemingly without particular reason.
|
544
|
+
proposed_change: The document should use a consistent fraction style throughout
|
545
|
+
the document, and also provide guidance on when these 3 different fraction presentation
|
546
|
+
styles apply.
|
547
|
+
observations: Accepted. The vertical form is used for both entries.
|
548
|
+
- id: CC-09-051
|
549
|
+
body: CC
|
550
|
+
locality:
|
551
|
+
line_number:
|
552
|
+
clause: Clause 4
|
553
|
+
element:
|
554
|
+
type: ed
|
555
|
+
comments: The practice of “cos(x) + y” vs “cos x + y” is not typically a source
|
556
|
+
of confusion because of operator precedence. This is similar to the example of
|
557
|
+
"5 x + 6” where rarely anyone will consider “5 (x + 6)” being an option. A better
|
558
|
+
example would certainly help. Instead, the component highlighted below in 2-20.17
|
559
|
+
might work better as an example of confusion.
|
560
|
+
proposed_change: Replace the example of “cos x + y” with something that actually
|
561
|
+
looks ambiguous, like the “sin” expression in Item 2-20.17.
|
562
|
+
observations: Accepted. Replaced.
|
563
|
+
- id: CC-10-052
|
564
|
+
body: CC
|
565
|
+
locality:
|
566
|
+
line_number:
|
567
|
+
clause: Whole document
|
568
|
+
element:
|
569
|
+
type: ge
|
570
|
+
comments: The ISO 80000 and IEC 80000 series should denote exact Unicode points
|
571
|
+
for all symbology used, especially for the math symbology used in ISO 80000-2.
|
572
|
+
In Unicode, there are many symbols in the math plane that can apply but provide
|
573
|
+
different semantics. It can be very confusing and frustrating when the user cannot
|
574
|
+
easily discover how to reproduce the notations given in the standard.Other standards
|
575
|
+
that utilize Unicode, such as those from ISO/TC 46/WG 3 (“Transliteration”) like
|
576
|
+
ISO 233 (Arabic transliteration), provide exact code points for every character
|
577
|
+
to avoid confusion.For example, in ISO 80000-2, it is clear that the character
|
578
|
+
of a matrix “bold italics A” (item 2-16.1) uses a different font from the natural
|
579
|
+
number set “bold sans-serif N” (item 2-7.1), but there is no described semantic
|
580
|
+
difference. In Unicode, the former character is part of the "Mathematical Bold
|
581
|
+
Italic Capital“ series (U+1D468) but the latter is part of the "Mathematical Sans-Serif
|
582
|
+
Bold Capital” series (U+1D5E1). If I use both symbols in a document, and change
|
583
|
+
the font to a sans-serif font, the “A” will be in the same presentation style
|
584
|
+
as the “N”, which is not what ISO 80000-2 intends.
|
585
|
+
proposed_change: The ISO 80000 and IEC 80000 series should denote exact Unicode
|
586
|
+
points for all symbology used, especially for the math symbology used in ISO 80000-2.
|
587
|
+
observations:
|
588
|
+
- id: CC-11-053
|
589
|
+
body: CC
|
590
|
+
locality:
|
591
|
+
line_number:
|
592
|
+
clause: Whole document
|
593
|
+
element:
|
594
|
+
type: ge
|
595
|
+
comments: 'There are some symbols in ISO 80000-2 that are not encoded in Unicode
|
596
|
+
but in some graphics-like format:Item 2-7.1, the first double struck N:Item 2-7.3,
|
597
|
+
the first double struck Q:Item 2-7.4, the first double struck R:'
|
598
|
+
proposed_change: A warning should be placed on these symbols because they are not
|
599
|
+
available in Unicode and therefore typically inaccessible (and cannot be used)
|
600
|
+
on computing devices, and therefore should not be used.
|
601
|
+
observations:
|
602
|
+
- id: CC-12-054
|
603
|
+
body: CC
|
604
|
+
locality:
|
605
|
+
line_number:
|
606
|
+
clause: Items2-12.262-12.272-20.52-20.6
|
607
|
+
element:
|
608
|
+
type: Ge
|
609
|
+
comments: In items 2-12.26, 2-12.27, 2-20.5, 2-20.6, the finite integral symbol
|
610
|
+
(the “⨍”) is incorrectly encoded. The “Finite Part Integral” symbol has code point
|
611
|
+
"U+2A0D” in Unicode. However, in ISO 80000-2, the finite integral symbol does
|
612
|
+
not use this correct character. This particular character in ISO 80000-2 is actually
|
613
|
+
re-created by composing two symbols overlapping each other by using “Character
|
614
|
+
spacing":When “Character spacing” is set to 0, this is what happens:Notice that
|
615
|
+
it is actually 2 symbols. The dash is actually "shifted" backwards to place on
|
616
|
+
top of the integral symbol. In some cases, the integral symbol is shifted backwards
|
617
|
+
instead to place it at the dash.This is not an intended use of Unicode characters
|
618
|
+
and should be avoided in ISO 80000-2, because:1. A reader who copies the finite
|
619
|
+
integral symbol is actually copying a sequence of 2 symbols, namely "∫-"2. The
|
620
|
+
reader who uses the correct Unicode finite integral symbol “⨍” will never be able
|
621
|
+
to match the presentation given in ISO 80000-2, because it was a custom, manually-created
|
622
|
+
symbol that is not reusable and interoperable.The relevant items that use this
|
623
|
+
symbol are provided below for reference.
|
624
|
+
proposed_change: Use the finite integral symbol as provided by Unicode.
|
625
|
+
observations: Accepted.
|
626
|
+
- id: CC-13-055
|
627
|
+
body: CC
|
628
|
+
locality:
|
629
|
+
line_number:
|
630
|
+
clause: Items 20-20.720-20.9
|
631
|
+
element:
|
632
|
+
type: Te
|
633
|
+
comments: Items 20-20.7 and 20-20.9 contain remarks that define “complementary functions”.
|
634
|
+
First of all, remarks should not contain any definition for functions. Moreover,
|
635
|
+
items 2-14.8, 2-14.9 … define inverse functions as separate items. It would make
|
636
|
+
sense for the "complementary functions” in 20-20.7 and 20-20.9 to be also defined
|
637
|
+
as individual items.
|
638
|
+
proposed_change: Define the "complementary functions” in 20-20.7 and 20-20.9 as
|
639
|
+
individual items.
|
640
|
+
observations:
|
641
|
+
- id: CC-14-056
|
642
|
+
body: CC
|
643
|
+
locality:
|
644
|
+
line_number:
|
645
|
+
clause: Clause 4 and document
|
646
|
+
element:
|
647
|
+
type: Ge
|
648
|
+
comments: Clause 4, paragraph 8, contains a permission that specifies the comma
|
649
|
+
as the preferred separator between numbers or expressions. However, notice that
|
650
|
+
in Clause 4, paragraph 6, it is already extremely confusing to see “… the function
|
651
|
+
and the argument, e.g. int 2,4; sin…”. In the case where a sentence already uses
|
652
|
+
the “comma” for sentence separation, not only that the embedded list of numbers
|
653
|
+
or expression shall not use the “comma” for list separation, but for the avoidance
|
654
|
+
of confusion, parentheses should not be omitted in functions if it contains a
|
655
|
+
"decimal comma”.For example, “… the function and the argument, e.g. int(2,4);
|
656
|
+
sin…” is much less confusing.It seems that the considerations around list separators
|
657
|
+
when using a “decimal comma” need to be better explained, specifically on how
|
658
|
+
the usage of the “decimal comma” affects the defined items in ISO 80000-2. In
|
659
|
+
ISO 80000-2, most of items use the “comma” to separate numbers/expressions.The
|
660
|
+
permission in Clause 4, paragraph 8 should further state that a consistent practice
|
661
|
+
should be applicable “context/document-wide” — the consideration is not only for
|
662
|
+
particular formulas inside a context/document, because it is important that a
|
663
|
+
reader can follow a consistent mathematical presentation practice throughout a
|
664
|
+
context/document. It could be simple as for a document to state its symbology
|
665
|
+
practice, if it uses the decimal comma for numbers, it will use the semicolon
|
666
|
+
for number separation.In Clause 4, paragraph 8, it says that a “semicolon” can
|
667
|
+
be used as an alternative separator. However, in ISO 80000-2, there are functions
|
668
|
+
that utilize the “semicolon” symbol for argument separation. Items 2-20.13 and
|
669
|
+
2-20.14 define specific meanings for what semicolons mean. This means that numbers
|
670
|
+
with decimal commas cannot utilize the “semicolon” symbol as a list separator
|
671
|
+
in these two items. Yet there are no alternatives provided in the document.Items
|
672
|
+
2-6.14 and 2-6.15 suggest that an additional alternative for separation two numbers
|
673
|
+
in an ordered pair/tuple can be the “stroke” symbol. This becomes “(a | b)” and
|
674
|
+
“(a1 | a2 | a3 | …)”.However, the “stroke” symbol is commonly used for stating
|
675
|
+
propositions (item 2-6.4), and when used consecutively it can be mistook for cardinality.e.g.
|
676
|
+
“(a1 | a2 | a3 )” can be interpreted as "(a1 card(a2) a3)” or “(a1, a2, a3)”.Or
|
677
|
+
we could follow the remarks in item 2-6.4 and reassign the “stroke” symbol for
|
678
|
+
propositions to only use the “colon”. However, the “colon” sign is also commonly
|
679
|
+
used for mapping (item 2-12.5 to 2-12.8).There is clearly more consideration that
|
680
|
+
needs to be fully thought through in the mathematical presentation practice stated
|
681
|
+
in ISO 80000-2 regarding the application of the decimal comma. ISO 80000-2 should
|
682
|
+
provide a consistent set of symbology for audiences using a decimal comma but
|
683
|
+
there are a number of gaps today in this area.
|
684
|
+
proposed_change: Reconsider fully the mathematical presentation practices stated
|
685
|
+
in ISO 80000-2 regarding the application of the decimal comma and provide refined,
|
686
|
+
accurate and actionable guidance.
|
687
|
+
observations:
|
Binary file
|