Skip to content
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

Explore adding an FAQ section #70

Open
pradyunsg opened this issue Aug 28, 2023 · 2 comments
Open

Explore adding an FAQ section #70

pradyunsg opened this issue Aug 28, 2023 · 2 comments

Comments

@pradyunsg
Copy link
Member

This has come up in multiple discussions over on toml-lang/toml, as a suggestion; for placing things that do not belong in the specification itself.

@pradyunsg
Copy link
Member Author

A few quick thoughts worth nothing down here:

I think this:

  • should NOT contain broad design guidance (eg: when to use booleans vs special "string" values).
  • should only provide guidance in the specific context of TOML (eg: what to use instead of None).
  • may also be a good place to provide information about why certain design choices were made (eg: no pragma)

The least effort way to do things would likely be to have minimal text in each answer and link to (or quote from) already provided responses on the TOML issue tracker.

@DominoPivot
Copy link

DominoPivot commented Aug 28, 2023

should NOT contain broad design guidance

Yeah, It's probably for the best to keep the scope small and focus on clarifying what TOML is and isn't. Opinions that aren't actually enforced by the language or part of its design principles should probably be left out.

The obivous Qs that come to mind:

  • Can I use TOML as a drop-in replacement for JSON or YAML?
  • Why is there no null in TOML?
  • What can I use to represent absence of a value instead of null?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants