View Issue Details

IDProjectCategoryView StatusLast Update
0037691FPCDocumentationpublic2020-09-02 23:57
ReporterWill B Assigned ToMichael Van Canneyt  
PrioritynormalSeverityminorReproducibilityN/A
Status resolvedResolutionfixed 
PlatformN/AOSN/A 
Fixed in Version3.3.1 
Summary0037691: Documentation for WriteLn needs small additions / corrections
DescriptionSub-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 InformationI 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.
TagsNo tags attached.
Fixed in Revision1734
FPCOldBugId
FPCTarget3.2.2
Attached Files

Relationships

related to 0037692 resolvedMichael Van Canneyt Documentation for Write needs small additions 

Activities

Will B

2020-09-02 20:31

reporter   ~0125301

Last edited: 2020-09-02 20:32

View 2 revisions

By extension, I suppose the documentation for 'Write' may need to be changed, as well. Should I file an issue for that too?

Michael Van Canneyt

2020-09-02 23:27

administrator   ~0125315

Added standard output to summary and refer to write for more details.

Will B

2020-09-02 23:57

reporter   ~0125320

Thank you :-)

Issue History

Date Modified Username Field Change
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