Updating Scarpet docs

[Ghoulboy78]

This is a relatively monumental task, so would have to be split within the separate files, each being updated with relevant docs and examples etc:

API docs

• Auxiliary.md (Updating Scarpet docs for Auxiliary.md #1415)
• BlockIterations.md (Updating Scarpet docs for BlockIterations.md #1754)
• BlockAndWorldAccess.md (Updating Scarpet docs for BlockIterations.md #1757)
• Entities.md
• Events.md
• Inventories.md
• Overview.md
• Scoreboard.md
• ScriptCommand.md

Language docs

• Containers.md
• FunctionsAndControlFlow.md
• LoopsAndHigherOrderFunctions.md
• Math.md
• Operators.md
• Overview.md
• SystemFunctions.md
• VariablesAndConstants.md

The idea is that anyone can reply here with one of the above files that they want to update

Rules for updating

Each function should have a detailed description with at least one example (the more the merrier obviously)

Each title description should have a detailed description of the section name.

[altrisi]

IMO if the whole docs are getting upgraded, we should also make a better doc format/framework than a simple markdown file, though that would be an even larger project.

[altrisi]

Also another thing, what do you think about changing code snippets to use code blocks with (py? js?) syntax highlighting instead of pres?

[Ghoulboy78]

Well, the reason I use <pre> is because I don't have grave accent on my keyboard, so it's harder. Also all the other examples use <pre> and they don't use any specific language

[James103]

At least on my end, if code is surrounded in <pre> </pre>, it appears in a multiline format, but if the code is surrounded in <code> </code> tags, anything in-between appears as inline code.

Example input:

<code> Inline code </code>

<pre> Multiline code </pre>

Output from above example:
Inline code

 Multiline code 

[altrisi]

Ik right now it's all pre, that's why I'm suggesting the change since this disc is about updating docs.

IMO this this just looks way better:

run_program() -> (
  loop( 10,
    // looping 10 times
    // comments are allowed in scripts located in world files
    // since we can tell where that line ends
    foo = floor(rand(10));
    check_not_zero(foo);
    print(_+' - foo: '+foo);
    print('  reciprocal: '+  _/foo )
  )
);
check_not_zero(foo) -> (
  if (foo==0, foo = 1)
)

than this:

run_program() -> (
  loop( 10,
    // looping 10 times
    // comments are allowed in scripts located in world files
    // since we can tell where that line ends
    foo = floor(rand(10));
    check_not_zero(foo);
    print(_+' - foo: '+foo);
    print('  reciprocal: '+  _/foo )
  )
);
check_not_zero(foo) -> (
  if (foo==0, foo = 1)
)

Not necessarily has to be done at the same time, just to keep the suggestion so it's not lost.

[altrisi]

Re James
With code blocks I meant ```, sorry, didn't even know <code> was a thing.

[Ghoulboy78]

I see your point here