View Issue Details

IDProjectCategoryView StatusLast Update
0000592LDMud 3.3Documentationpublic2009-01-16 14:12
ReporterSorcerer Assigned Tozesstra  
PrioritynormalSeveritytextReproducibilityalways
Status resolvedResolutionfixed 
Product Version3.3.716 
Target Version3.3.719Fixed in Version3.3.719 
Summary0000592: documentation of read_file() is misleading
DescriptionThe man-page for read_file() states:
[...]
If <start> is not given or 0, the file is read from the
beginning, else the efun skips the given number of lines and
starts reading from the next one.
[...]

This should be (to be consistent with actual behavior):
[...]
If <start> is not given or 0, the file is read from the
beginning, else the efun starts reading at the beginning of
line <start>.
[...]

The German manpage should be updated accordingly.
TagsNo tags attached.

Activities

Gnomi

2009-01-11 11:03

manager   ~0000875

I like the documented behavior better than the actual behavior. But sadly correcting the actual efun would break a lot of code...

zesstra

2009-01-11 12:01

administrator   ~0000876

Most of the read_file() calls in MG just read in the whole file. But even so there are still plenty left.
I don't have any preference about the 'start' semantic where the first line to be read is given vs. the 'skiplines' semantic where the number of lines to be skipped is specified. I personally am quite sure it is not worth a lot of work to change the semantics now...

zesstra

2009-01-13 17:22

administrator   ~0000887

If nobody vetoes, I will change the documentation... ;-)

zesstra

2009-01-16 14:12

administrator   ~0000909

Changed in r2495, thank you. :-)

Issue History

Date Modified Username Field Change
2009-01-11 10:44 Sorcerer New Issue
2009-01-11 11:03 Gnomi Note Added: 0000875
2009-01-11 12:01 zesstra Note Added: 0000876
2009-01-13 17:22 zesstra Note Added: 0000887
2009-01-13 17:22 zesstra Assigned To => zesstra
2009-01-13 17:22 zesstra Status new => assigned
2009-01-13 17:22 zesstra Target Version => 3.3.719
2009-01-16 14:12 zesstra Note Added: 0000909
2009-01-16 14:12 zesstra Status assigned => resolved
2009-01-16 14:12 zesstra Fixed in Version => 3.3.719
2009-01-16 14:12 zesstra Resolution open => fixed