-
Notifications
You must be signed in to change notification settings - Fork 856
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Re-organization of sections in TOML documentation/specification #704
Comments
As little crazy doc-writing thing: we may describe each statement of TOML specification inside sets of It smells like over-engineering, but makes thing fun. |
I'm not sure what the goal here is anymore -- we have toml-lang/toml.io#1 for creating a better user-facing documentation, if that's the intent here. As for restructuring the sections, I think it could be useful to do. I've dabbled with the idea a couple of times myself, but I'm very wary of making such a change prior to 1.0 -- it's one more thing to do before 1.0, one more thing that could introduce issues (etc) -- I'm very much at a point where I'd much rather release the current spec as 1.0; and iterate on the remaining improvements after that. As for having segments across multiple .toml files, that'll get "compiled" into formats -- let's not do that; it is very much over-engineering and simpler systems are better than complex one. :) |
I'm generally in favor of reorganizing the sections (in fact, I suggested it). But whether that should happen before or after 1.0 I leave to the maintainers' decision. Indeed I'm very much in favor of getting 1.0 published quickly, which suggests postponing this. |
I'm on board for doing this, but as mentioned before I think this is best done as a post 1.0 task. :) |
Looking at this and the spec in some detail again, the current spec works pretty well. I don't think there's need for a drastic restructuring as has been proposed in this issue. Thanks for the suggestion none the less @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:
Notes:
Comparison with Other Formats
andExample(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).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)
The text was updated successfully, but these errors were encountered: