View Issue Details
|ID||Project||Category||View Status||Date Submitted||Last Update|
|0037691||FPC||Documentation||public||2020-09-02 20:29||2020-09-02 23:57|
|Reporter||Will B||Assigned To||Michael Van Canneyt|
|Fixed in Version||3.3.1|
|Summary||0037691: Documentation for WriteLn needs small additions / corrections|
- - -
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"
- - -
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."
- - -
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.|
|Tags||No tags attached.|
|Fixed in Revision||1734|
By extension, I suppose the documentation for 'Write' may need to be changed, as well. Should I file an issue for that too?
||Added standard output to summary and refer to write for more details.|
||Thank you :-)|
|2020-09-02 20:29||Will B||New Issue|
|2020-09-02 20:29||Will B||Status||new => assigned|
|2020-09-02 20:29||Will B||Assigned To||=> Michael Van Canneyt|
|2020-09-02 20:31||Will B||Note Added: 0125301|
|2020-09-02 20:32||Will B||Note Edited: 0125301||View Revisions|
|2020-09-02 20:55||Will B||Issue cloned: 0037692|
|2020-09-02 23:27||Michael Van Canneyt||Relationship added||related to 0037692|
|2020-09-02 23:27||Michael Van Canneyt||Status||assigned => resolved|
|2020-09-02 23:27||Michael Van Canneyt||Resolution||open => fixed|
|2020-09-02 23:27||Michael Van Canneyt||Fixed in Version||=> 3.3.1|
|2020-09-02 23:27||Michael Van Canneyt||Fixed in Revision||=> 1734|
|2020-09-02 23:27||Michael Van Canneyt||FPCTarget||=> 3.2.2|
|2020-09-02 23:27||Michael Van Canneyt||Note Added: 0125315|
|2020-09-02 23:57||Will B||Note Added: 0125320|