More documentation! about tomlplusplus

[jwillikers]

Hi @marzer, thanks for all of your work on this library. The API looks beautifully simple. When choosing whether to use a library like this, it is very helpful for me to see examples of the error messages from the error-handling functions. In your documentation, I saw the error-handling examples but they didn't show the full output for a sample case. That would be helpful for me to see. Thanks!

[marzer]

@jwillikers Thanks, glad you like it!

That's a good idea, I should add a few failure cases to the examples. In the mean-time you can get a good idea of how they're formatted and their level of detail by skimming through toml_parser.h and picking out the occurences of abort_with_error().

[jwillikers]

@marzer Thanks, I appreciate it!

[marzer]

Checklist of documentation stuff for me to do when I get the chance:

• Add examples of error messages to the index page and parse_result's brief
• Boolean literals in code blocks are bold white, but really should be blue like keywords (see operator<<(ostream, node_type))
• The Contributing link on the front page of the HTML docs refers to README.md but should refer to CONTRIBUTING.md
• Add a prominent listing of the currently tested platforms and compilers to the README.md and HTML docs
• Add more detail to the code examples for toml::parse and friends
• Add a code example for toml::parse_error
• Use a different favicon for the HTML docs

[marzer]

@jwillikers In addition to a few minor code bugfixes I've just pushed a bunch of documentation improvements that might be relevant to your interests:

• index.html (added error message example and known supported/tested platforms)
• toml::parse_result (added error message example)

Let me know what you think and/or if there's something I've missed.