Ticket UUID: | 3011289 | |||
Title: | Modification to Tcl manpage | |||
Type: | RFE | Version: | None | |
Submitter: | coldstore | Created on: | 2010-06-04 00:13:26 | |
Subsystem: | 69. Other | Assigned To: | dkf | |
Priority: | 5 Medium | Severity: | Minor | |
Status: | Open | Last Modified: | 2016-08-20 17:10:37 | |
Resolution: | None | Closed By: | nobody | |
Closed on: | ||||
Description: |
I don't see a 'documentation' category, so am categorising this 'Other' until a better alternative presents. I take http://www.tcl.tk/man/tcl8.5/TclCmd/Tcl.htm to be the canonical form of the Tcl man page on 4Jun2010. I have issue with http://www.tcl.tk/man/tcl8.5/TclCmd/Tcl.htm#M6 For reasons given here http://wiki.tcl.tk/10259 and restated below, I believe the Tcl man page should be modified for clarity, as follows: I would like to see Rule 2. split into two numbered parts. The rule announces initially that it has two steps, starts out with 'First', and then never explicitly states 'Second', or 'Then', but instead buries the subsequent step inside the text. This has the effect of making the the two steps run into one another, in a literal confusion. Secondly, I would like to examine the wisdom of the applicable-everywhere assertion in 2. Firstly, it's provably false - unknown can and frequently does modify the application of commands. Secondly, it over-constrains the language to no real benefit. Thirdly, even if it were true, and were desirable, it is also strongly implied by Rule 7 (which 2. invokes) and the lack of other mechanisms for command substitution. At best, it is a clarification masquerading as a general principle. I will construct and here attach a variation to the text which I believe addresses these concerns. | |||
User Comments: |
coldstore added on 2010-06-04 07:22:02:
File Added - 376149: mod-doc coldstore added on 2010-06-04 07:17:21: data_type - 360894 |
Attachments:
- mod-doc [download] added by coldstore on 2010-06-04 07:22:02. [details]