Replace auto-generated documentation #2

guilherme-gm · 2019-05-02T17:15:43Z

Pretty much the entire command documentation was auto-generated from script_commands, while it may provide a lot of info, most of the time it looks bad on the editor, so they must be rewritten to a better format (e.g. using markdown, properly giving parameters info, etc.)

To update a command you have to update its json file at:
https://github.com/guilherme-gm/vscode-herc-lang-support/tree/master/server/src/commands

This is the format:

{
    "commandName": {
        "params": [
            { // Each { } represents one signature for the command
                "requiredParam1Name": "requiredParam1Type",
                "requiredParam2Name": "requiredParam2Type",
                "optionalParam3": {
                    "type": "optionalParam3type",
                    "default": "optionalParam3defaultValue"
                }
            }
        ],
        "doc": [ // Command documentation
            // Split it in multiple lines for readability, it doesn't affected generated text
           // Markdown supported
            "description",
            "descritpion"
        ],
        "paramDoc": { // parameters documentation
            "param1Name": "param1Desc",
            "param2Name": "param2Desc",
            "param3Name": "param3Desc"
        }
    }
}

Check getitem for a complete example.

List of Commands:

The text was updated successfully, but these errors were encountered:

guilherme-gm added help wanted Extra attention is needed good first issue Good for newcomers labels May 2, 2019

guilherme-gm removed good first issue Good for newcomers help wanted Extra attention is needed labels Sep 11, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace auto-generated documentation #2

Replace auto-generated documentation #2

guilherme-gm commented May 2, 2019 •

edited

Loading

Replace auto-generated documentation #2

Replace auto-generated documentation #2

Comments

guilherme-gm commented May 2, 2019 • edited Loading

guilherme-gm commented May 2, 2019 •

edited

Loading