SRL Archive - OSR Help

contribute Simba docs

kazhual

2012-10-30 06:46:27

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.

slushpuppy

2012-10-30 07:29:22

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

kazhual

2012-10-30 07:46:33

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

masterBB

2012-10-30 07:54:35

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

P1ng

2012-10-30 07:57:30

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 :)

Daniel

2012-10-30 08:00:46

From: masterBB
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 :)

masterBB

2012-10-30 08:09:29

From: Daniel
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.


(*
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!');

*)

kazhual

2012-10-30 08:17:36

From: masterBB
Ah nice. Then it is even easier. Go to github, in this example amount.simba. Click edit and create a pull request after saving.


(*
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?

riwu

2012-10-30 08:35:32

From: Daniel
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?

From: kazhual
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/

kazhual

2012-10-30 08:38:57

Thanks ,

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

kazhual

2012-10-30 08:48:48

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