Jump to content
guinness

Help File/Documentation Issues. (Discussion Only)

Recommended Posts

2 hours ago, seadoggie01 said:

There isn't output listed anywhere, you have to run the programs :) (I get it though, I looked for it too)

Do you know if that’s by design or?

As in, if we make it so people download the examples to get an answer, then maybe they’ll just keep going and write the program.

On the other hand, there are some people myself included, who just read them sequentially, hoping to create that vague sense of “I think there is a function that does x...”, which can be helpful.  I worked with a guy who studied all the error codes for Oracle without having a problem in front of him - now that’s going too far.

I’m assuming it’s on purpose though, because I know people can modify the help, and I’m sure people would volunteer, and yet there still is not even one output AFAIK.

Edited by JockoDundee

Code hard, but don’t hard code...

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By water
      Due to corona I have a  lot of spare time at the moment. So I started to create a "real" help file fo the AD UDF (MS Active Directory).
      This help file should look/work like the AutoIt help file.

      Attached you find the first beta of the AD help file.
       
      Done so far:
      Similar functions have been assigned to a group (example: mail, mailbox and Exchange related functions have been assigned to the "EMail" group) Content, Search and Index tabs work Formatting is similar to the AutoIt help file Introduction page ToDo:
      Fill index tab Use folder icons Set the correct font size for the TOC Enhance the CSS to fully match the formatting of the AutoIt help file Create a documentation so you can create CHM files for other homegrown UDFs Create pages for the chapters - return an error message at the moment Upgrade to the latest version of Microsoft HTML Workshop Seems 1.3 is the latest What do you think?
      Is something still missing on the ToDo-list?
      Comments please
      AD.chm
    • By Skysnake
      I tried to create a ticket and Trac told me my submission looks like spam.  I do not see a captcha on either of the submission or "spam" screens...
       
      Tiny little documenation issue:
      GUICtrlRegisterListViewSort
      Example 1 on Line 17
      The documentation refers to the function "SortLV" where it is in fact "LVSort" used in the example.
      Example 2 uses "LVSort2" (correct)
    • By l3ill
      Hi,
        been searching for a way to Pause a HotKeySet and it would seem that the Help File has one beautifully prepared.
      But it turns out that Pause does not stop the HotKeySet from working.
        Anyone know why? And/Or how to fix it?
      Thanks,
      Bill
    • By guinness
      This post outlines correct usage of reporting a documentation error in AutoIt.

      To report a help file issue, first navigate to Trac and create a new ticket. Ensure that the issue isn't present in the latest available version e.g. beta version and follow the following requirements for submitting:
      Change the "Component" option to Documentation. Change the "Version" option to whichever version you saw the issue in. It's preferred that you check the latest version .e.g. current beta, before submitting the ticket. Be as descriptive as you can when posting an issue, the more information you can provide e.g. where you found the issue and what it should be, will aid in the problem being fixed quickly. Up until now those that have posted have done so in a clear and concise manner, so lets keep it that way please. If this starts to deviate in any way then I will be forced to adopt a more strict approach.
      >Previous 'Report Help File Issues' thread.

      Issues with AutoIt:
      For reporting an issue with AutoIt ensure you've isolated the problem in a small script that reproduces the error, assessed in the General Help and Support Forum that it's not a problem with poorly written code and then if none of those fix the problem, post to Trac for an AutoIt Developer to assess the issue.
×
×
  • Create New...