Results 1 to 11 of 11

Thread: contribute Simba docs

  1. #1
    Join Date
    Jan 2012
    Location
    Netherlands
    Posts
    76
    Mentioned
    0 Post(s)
    Quoted
    3 Post(s)

    Default contribute Simba docs

    Hello,

    I would like to contribute to the Docs of simba for missing examples.
    for example: http://docs.villavu.com/srl-5/gametab.html
    And there are way more.

    It bothers me for people who want to learn but have to search all over the place for an example.
    I would like to write simple examples for people who are learning the functions.

  2. #2
    Join Date
    Oct 2011
    Posts
    422
    Mentioned
    15 Post(s)
    Quoted
    116 Post(s)

    Default

    villavu should have a suggestions subforum and yes this is a very good idea

  3. #3
    Join Date
    Jan 2012
    Location
    Netherlands
    Posts
    76
    Mentioned
    0 Post(s)
    Quoted
    3 Post(s)

    Default

    The only problem is that you need to get Write Acces at github.
    Just by looking at it I know how it works.

  4. #4
    Join Date
    Oct 2006
    Location
    Netherlands
    Posts
    3,285
    Mentioned
    105 Post(s)
    Quoted
    494 Post(s)

    Default

    It is already possible to do this. Instal Sphinx and create pull request to this place: https://github.com/SRL/SRL-5/tree/master/doc/sphinx
    Working on: Tithe Farmer

  5. #5
    Join Date
    Apr 2012
    Location
    Australia
    Posts
    1,252
    Mentioned
    1 Post(s)
    Quoted
    22 Post(s)

    Default

    Maybe post some functions with their descriptions and examples that you'd like to see in the documentation and the chances are a staff member might see those and commit them

  6. #6
    Join Date
    Dec 2006
    Location
    Sydney, New South Wales, Australia
    Posts
    4,603
    Mentioned
    15 Post(s)
    Quoted
    42 Post(s)

    Default

    Quote Originally Posted by masterBB View Post
    It is already possible to do this. Instal Sphinx and create pull request to this place: https://github.com/SRL/SRL-5/tree/master/doc/sphinx
    Silly masterBB. The Sphinx documentation is generated from the .simba files in SRL. So, make changes to those instead
    You may contact me with any concerns you have.
    Are you a victim of harassment? Please notify me or any other staff member.

    | SRL Community Rules | SRL Live Help & Chat | Setting up Simba | F.A.Q's |

  7. #7
    Join Date
    Oct 2006
    Location
    Netherlands
    Posts
    3,285
    Mentioned
    105 Post(s)
    Quoted
    494 Post(s)

    Default

    Quote Originally Posted by Daniel View Post
    Silly masterBB. The Sphinx documentation is generated from the .simba files in SRL. So, make changes to those instead
    Ah nice. Then it is even easier. Go to github, in this example amount.simba. Click edit and create a pull request after saving.

    Simba Code:
    (*
    TradeScreen
    ~~~~~~~~~~~

    .. code-block:: pascal    
           function TradeScreen: Integer;

    Returns 1 if the first trade screen is open, 2 if the second, and 0 if neitheris open.

    .. note::    
           Author: ZephyrsFury    
           Last Modified: 12/7/11 by Legoace

    Example:

    .. code-block:: pascal    
           if (TradeScreen > 0) then    
           writeln('Trade screen is open!');

    *)
    Working on: Tithe Farmer

  8. #8
    Join Date
    Jan 2012
    Location
    Netherlands
    Posts
    76
    Mentioned
    0 Post(s)
    Quoted
    3 Post(s)

    Default

    Quote Originally Posted by masterBB View Post
    Ah nice. Then it is even easier. Go to github, in this example amount.simba. Click edit and create a pull request after saving.

    Simba Code:
    (*
    TradeScreen
    ~~~~~~~~~~~

    .. code-block:: pascal    
           function TradeScreen: Integer;

    Returns 1 if the first trade screen is open, 2 if the second, and 0 if neitheris open.

    .. note::    
           Author: ZephyrsFury    
           Last Modified: 12/7/11 by Legoace

    Example:

    .. code-block:: pascal    
           if (TradeScreen > 0) then    
           writeln('Trade screen is open!');

    *)
    So All I have to do is:
    1. Click edit
    2. Edit stuff between the
    (*
    ....
    ....
    *)
    Acording to what i want to edit.
    3. create a pull request after saving.

    How Does the pull request work?

  9. #9
    Join Date
    Jan 2012
    Posts
    2,568
    Mentioned
    35 Post(s)
    Quoted
    356 Post(s)

    Default

    Quote Originally Posted by Daniel View Post
    Silly masterBB. The Sphinx documentation is generated from the .simba files in SRL. So, make changes to those instead
    Wow i didn't know that!
    No wonder all the documentation has this
    .. code-block:: pascal
    I thought it's just for neatness, so it's actually for a very practical purpose!

    The online docs are pretty useless then since it's mostly outdated and you can directly view the docs within srl/core?

    Quote Originally Posted by kazhual View Post
    So All I have to do is:
    1. Click edit
    2. Edit stuff between the
    (*
    ....
    ....
    *)
    Acording to what i want to edit.
    3. create a pull request after saving.

    How Does the pull request work?
    You will have to get used to github and its mechanisms.
    Try read through the guides at:
    https://help.github.com/

  10. #10
    Join Date
    Jan 2012
    Location
    Netherlands
    Posts
    76
    Mentioned
    0 Post(s)
    Quoted
    3 Post(s)

    Default

    Thanks ,

    Ill guess i have to find out how the pull request works

  11. #11
    Join Date
    Jan 2012
    Location
    Netherlands
    Posts
    76
    Mentioned
    0 Post(s)
    Quoted
    3 Post(s)

    Default

    Thanks for the info all !

    Succesfully added and example to: GetMMLevels
    Succesfully 'Request pullup'

    For the functions i use in my own script i will try to create a simple example

Thread Information

Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Tags for this Thread

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •