Help File/Documentation Issues. (Discussion Only)

[guinness]

Note: Any issues that are reported in this thread are not guaranteed to be seen by a Developer and therefore fixed.

If you would like to report an issue then please navigate to Help File/Documentation Issues and follow the instructions.

This thread is used to discuss about help file issues only and ideas that people might have to improve future releases of the help file. This has been created so as not to bloat the Tracker with discussion based comments.

Thank you.

 

Edited August 12, 2015 by guinness

[mLipok]

so I start

in _FileOpen

in Remarks

Is there not been used for a lot of breaks between EDIT: ?

something like in _FileListToArrayRec

EDIT: Can this be changed ?

Edited August 18, 2013 by mlipok

[guinness]

Are you discussing or reporting?

[mLipok]

I edit my post.

Is now my previous statement look for discussion?

[guinness]

I guess you mean FileOpen? This is intentional.

[mLipok]

sorry you have right FileOpen

ok.

[guinness]

I could change to this ... to fix the blank space at the top as right now it's an unordered list.

1. FileOpen does this...
2. and this...
3. Oh, not use this too.

[mLipok]

Ok, now all is clear for me.

This entry was supposed to be a Track Ticket

Am I right.

[guinness]

Yes, but don't worry about it this time.

[mLipok]

Observed that in some descriptions in the documents, for example, to "FileOpen" and more specifically in the "Related" includes links to not only to the other descriptions, but also to the same, ie "FileOpen".

  Quote

 

• A file can be read as binary (byte) data by using FileOpen() with the binary flag.

 

Was that intentional?

By clicking on the link, you may be a little confused.

In my opinion, keep that string, as the link is not entirely good.

What else this string in the current color.

 

What is your opinion?

 

I've seen more of these cases.

Moreover, so far reporting the missing links in the documentation I have always tried to ignore such cases.

 

Should I continue to ignore them or to report a change?

 

Of course report, in the TRACK.

[mLipok]

Currently in helpfile in various documentation, shall apply different ways of describing the parameters of the same type.

For example, I can give a description of _FileReadToArray and FileOpen

 

  Quote

_FileReadToArray ( $sFilePath, ByRef $aArray [, $iFlag = 1] )

$sFilePath Path and filename of the file to be read.

 

  Quote

FileOpen ( "filename" [, mode = 0] )

filename Filename of the text file to open.

 

I see that the same difference occurs in calltips.

What is the cause of this discrepancy?

Edited August 20, 2013 by mlipok

[jaberwacky]

I guess this should be asked before I submit a ticket.  In the helpfile under DriveGetFileSystem there is this explanation, "NTFS Typical file system for Windows hard drives."  I'm just wondering if it should indicate Windows starting with Vista (or whenever NTFS was debuted)?

[jaberwacky]

Another silly question.  I noticed that the name of DriveMapDel suggests the deletion of a drive.  I assume that del is short for delete.  The rest of the page suggests the disconnection of a network drive.  Is there a difference?

[jaberwacky]

In FileCreateNTFSLink, should the options for the flag parameter be constants?

Currently it is this:

flag

[optional] this flag determines whether to overwrite link if they already exist.
Can be a combination of the following:
0 = (default) do not overwrite existing link
1 = overwrite existing link

I'm aware that $FC_OVERWRITE and $FC_NOOVERWRITE could be used but that's beside the point.

[jaberwacky]

FileGetVersion says that this will return the version of the autoit that was used to compile the exe: FileGetVersion(@AutoItExe, "CompiledScript")

So I compiled the following script and ran it but got nought on 3.3.9.18.

#include <Constants.au3>

MsgBox($MB_OK, '', FileGetVersion(@AutoItExe, "CompiledScript") & @CRLF)

Have I simply misunderstood?

I should just go ahead and submit these as trac tickets huh?

I realized this isn't a helpfile issue.  Durrr.

Edited August 21, 2013 by jaberwocky6669

[jaberwacky]

Should mention that these all apply to 3.3.9.18.

Eh, not completely true.  I realized I still had 3.3.9.17 doc source.  Oops!

Just checked and they still apply.  Whew.

Edited August 21, 2013 by jaberwocky6669

[AdmiralAlkex]

  On 8/21/2013 at 3:54 AM, jaberwocky6669 said:

I guess this should be asked before I submit a ticket.  In the helpfile under DriveGetFileSystem there is this explanation, "NTFS Typical file system for Windows hard drives."  I'm just wondering if it should indicate Windows starting with Vista (or whenever NTFS was debuted)?

NTFS debuted with Windows NT 3.1

  On 8/21/2013 at 4:06 AM, jaberwocky6669 said:

Another silly question.  I noticed that the name of DriveMapDel suggests the deletion of a drive.  I assume that del is short for delete.  The rest of the page suggests the disconnection of a network drive.  Is there a difference?

No. It's just a name.

[mLipok]

I have a new proposal for an interesting observation and concepts in a global scale, ie the whole HelpFile.

 

First:

Please look at the documentation for the function _ArrayDelete

Please focus on the yellow box constructor

# include <Array.au3>
_ArrayDelete (ByRef $ avArray, $ iElement)

 

Second:

Please look at the documentation for the function StringCompare

Please focus on the yellow box constructor

StringCompare ("string1", "string2" [, casesense = 0])

 

Third:

Please look at the documentation for the function StringCompare

Please focus on the Remarks section

  Quote

To use the values ​​specified above you must # include <StringConstants.au3> in your script

 

 

 

 

Summary of what I've observed, and also what I would like to discuss:

 

1. The first example is for me the most correct.
2. The second example in the constructor does not contain any relevant references to # inculde files. As a result, in order to properly use the function, but I have every time to read all the documentation for this function and copy text from two different places this documentation.
3. A third example: well here at all I was surprised that description. I wonder whether he is here at the right place.

 

Please your opinion what do you think about this.

 

 

[jaberwacky]

  On 8/21/2013 at 5:09 AM, AdmiralAlkex said:

NTFS debuted with Windows NT 3.1

 Cool.  It's as it should be then.  Thanks!

[czardas]

  On 8/21/2013 at 5:27 AM, mlipok said:

1. The second example in the constructor does not contain any relevant references to # inculde files. As a result, in order to properly use the function, but I have every time to read all the documentation for this function and copy text from two different places this documentation.

 

Please read the above number as 2. (auto bullets and numbering incorrections - bleh)

StringCompare() is a native function. You may not wish to include the optional parameters. Besides you could also pass magic numbers to the function without the includes.

Edited August 21, 2013 by czardas