Skip to content

[Doc] Introduction #210

@ShalokShalom

Description

@ShalokShalom

Hi there :)

As of now, there is no proper explaination to the initial code example in the docs.

https://github.com/IppClub/YueScript/tree/main/doc/docs/doc#an-overview-of-yuescript

Looking up 'object literals' in the docs, (with ctrl+f) yields no results.

I suggest to add the following text:

In Yuescript, object literals are a syntax for defining Lua tables (objects/dictionaries) with a more expressive and concise style. The * symbol is used to denote list elements or multiple entries within a table.

Also the pipes are not explained at all.

I didn't send a PR, since I wanted to ask permission, to rearrange the docs a bit too, before I do.

Now, a lot of the very basic stuff, like importing, is fairly far down, while arguably one of the most difficult features is very much on the top.

A beginner should start with imports, and not macros ;)

Do you agree, then I send you a PR

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions