Modify

Opened 6 years ago

Closed 6 years ago

#2418 closed Feature Request (Completed)

Where to add a description about file with constants definition. REMARKS / PARAMETERS

Reported by: mlipok Owned by: Jpm
Milestone: 3.3.9.22 Component: Documentation
Version: Severity: None
Keywords: Cc:

Description

this was discused here:
http://www.autoitscript.com/forum/topic/153782-help-filedocumentation-issues-discussion-only/page-3#entry1110680

It is the sentence of this discussion:

I would like her to be selected one correct option on how the description of the relevant file, which contains the definition of constants:

the first option (for example, a StringInStr)

parameter description: "Constants are defined in Constants.au3"
and
in Remarks: "The use of the values ​​specified above you must # include <StringConstants.au3> in your script."

the second option (for example, a DirCopy)

parameter description: "Constants are defined in FileConstants.au3"
and
in Remarks: no additional information

there is also a third option but I have not noticed in the present documentation:

in the description of the parameters: no additional information
and
in Remarks: Contains additional information

Attachments (0)

Change History (7)

comment:1 Changed 6 years ago by TicketCleanup

  • Version 3.3.9.18 deleted

Automatic ticket cleanup.

comment:2 Changed 6 years ago by anonymous

as an example, please look for GUISetFont
there is used both as GUIConstantsEx.au3 FontConstants.au3, wherein FontConstants.au3 is used twice.

All these files are listed in section Parmeters

I think the solution is clear.
I would suggest possibly before and after
"Constants are defined in ..."
add an extra blank line.

To stand out this information.

comment:3 Changed 6 years ago by mlipok

On the other hand, for example, MsgBox () shows an example of display the information concerning constants in the remarks.
in this case, this option is much better because of the amount of information.

comment:4 Changed 6 years ago by Mat

  • Owner set to Mat
  • Status changed from new to assigned

The second option is what I have been using. Will take a look at which docs are doing things differently

comment:5 Changed 6 years ago by mlipok

I found an example where it has no specified appropriate file:
GUICtrlCreateListViewItem

comment:6 Changed 6 years ago by Jpm

at least the signaled help are fixed in the beta

comment:7 Changed 6 years ago by Jpm

  • Milestone set to 3.3.9.22
  • Owner changed from Mat to Jpm
  • Resolution set to Completed
  • Status changed from assigned to closed

Added by revision [9094] in version: 3.3.9.22

Guidelines for posting comments:

  • You cannot re-open a ticket but you may still leave a comment if you have additional information to add.
  • In-depth discussions should take place on the forum.

For more information see the full version of the ticket guidelines here.

Add Comment

Modify Ticket

Action
as closed The owner will remain Jpm.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.