Skip to content

Re-organization of sections in TOML documentation/specification  #704

@Suhoy95

Description

@Suhoy95

There is an description issue that key/value pair and table are described to far away from each other, which cause problem of misunderstanding (especially if you do not familiar with hash table)

As it was mentioned, there are top-down and bottom-up approach to describe something (and TOML particularly)

This proposal shows bottom-up approach:

0. Preamble
1. Example 
2. Spec
    2.0 Comment
    2.1 Basic types
        2.1.0 Boolean
        2.1.1 Integer
        2.1.2 Float
        2.1.3 String (`# it is cool that String comes before Keys`)
    2.2 Table
        2.2.1 Key/Value Pair (`# because it is part of the Table type`)
        2.2.2 Keys syntax (better rename to "Key" for consistency with other headings)
        2.2.3 Inline Table (special syntax)
    2.3 Array
        2.3.0 Array of Tables (special syntax)
    2.4 Date and Time
        2.4.0 Offset Date-Time
        2.4.1 Local Date-Time
        2.4.2 Local Date
        2.4.3 Local Time
3. Environment related points (`# I do not know how to name it better`)
    3.0 Filename Extension
    3.1 MIME Type
4. Comparison with Other Formats
5. Community
    5.0 Get Involved
    5.1 Wiki

Notes:

  1. Comparison with Other Formats and Example(s) may be merged and put in the beginning. So regular TOML user will be able to easily get started with it (if they know one of other format).
  2. I try to do just restructuring, but this discussion may cause more serious changes. I think that each sentence should be read and accordingly rewritten

The topic was touched in the notes (#701, Points 2, 3, 6) and popped up in #702 PR.

Proof-of-Concept: pdf and the separated PR (#703)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions