DevPortal

Errors in documentation

Home Forums Developing with SmartBots HTTP API Errors in documentation

Viewing 3 posts - 1 through 3 (of 3 total)
  • Author
    Posts
  • #295
    Heyter Nitely
    Participant

    Hey,

    I’ve been working on updating the current PHP SmartBots class to PHP 7.1, having PHPDoc in it and I noticed some issue in the current documentation:

    `- https://www.mysmartbots.com/dev/docs/HTTP_API/Bot_Commands/sim_kick The input parameters are missing, we can only see them in the example
    – In the left menu, Bots Commands, there are “sim restart” and “simrestart” that redirect us to the same page, https://www.mysmartbots.com/dev/docs/HTTP_API/Bot_Commands/sim_restart (I saw the article about this function and the name change, but maybe remove simrestart from the menu and add in the comment that simrestart is still working ?)
    – sim_return have the comments that should go to sim_access.
    – sim_return have the sim_restart example.
    – sim_access don’t have any comments concerning the operation input, there are in the sim_access.
    – attachments, avatar_groups, avatar_picks, name2key, offer_friendship, offer_teleport, set_http_callback, sit, precision don’t mention if inputs are optional or not
    – missing inputs:
    sim_kick -> avatar parameter is missing (only in example)
    sim_return -> avatar parameter is missing (only in example)
    – in list_group_roles, groupuuid should go under input, not Input basic parameters
    – in sim_send_message, message should be required ?

    Hope this helps !

    #296
    Glaznah Gassner
    Keymaster

    Hello Heyter!

    I appreciate your report, we will examine each page and make the necessary fixes.

    sim_restart and simrestart are the same commands. “simrestart” still reside in the menu to avoid the broken link from older pages, will check for the way to get it of it.

    Thank you!

    #303
    Glaznah Gassner
    Keymaster

    Hey Heyter!
    We’ve fixed all docs issues you’ve mentioned. Thank you!

    I would add a free time to your bot, but you own a free bot as a developer :) Drop me a word if I can do anything else for you!

Viewing 3 posts - 1 through 3 (of 3 total)
  • You must be logged in to reply to this topic.