Documentation for WriteLn needs small additions / corrections
Original Reporter info from Mantis: Buttercup5000
-
Reporter name: Will B
Original Reporter info from Mantis: Buttercup5000
- Reporter name: Will B
Description:
Sub-issue 1:
- - -
In the documentation, the current summary says:
"Write variable to a text file and append newline"
This makes no mention of the fact that WriteLn can be used to write to standard output.
A suggested change to this would be
"Write variable to a text file or standard output and append newline"
Sub-issue 2:
- - -
In the current documentation, the following line has a huge space between 'Remark:' and 'The':
"Remark: The newline character is determined by the slinebreak constant."
Sub-issue 3:
- - -
The current documentation does not mention that WriteLn causes an exception on Windows when no file is open on GUI apps. Maybe this should be another 'Remark:'?
Additional information:
I believe implementing the changes mentioned will help clarify the documentation for newer users who may be puzzled by WriteLn's failure on Windows GUI apps, as well as clearly acknowledging that WriteLn actually can be used to write to standard output when no file is open.
Mantis conversion info:
- Mantis ID: 37691
- OS: N/A
- OS Build: N/A
- Platform: N/A
- Fixed in version: 3.3.1
- Fixed in revision: 1734 (#96fddba3)
- Monitored by: » Buttercup5000 (Will B)
- Target version: 3.2.2