this post was submitted on 15 Aug 2023
43 points (100.0% liked)

Experienced Devs

3956 readers
1 users here now

A community for discussion amongst professional software developers.

Posts should be relevant to those well into their careers.

For those looking to break into the industry, are hustling for their first job, or have just started their career and are looking for advice, check out:

founded 1 year ago
MODERATORS
 

.yaml, .toml, etc?

you are viewing a single comment's thread
view the rest of the comments
[โ€“] simonced@lemmy.one 1 points 1 year ago (1 children)

I liked the idea to be honest. I can just call the entry "description" instead and all is good ^^

[โ€“] AeroLemming@lemm.ee 2 points 1 year ago

Ideally, you would use TOML for human-readable configuration and document your JSON API with external documentation instead of sending comments around a bunch. If you need to display the description to the end user though, that would be a valid use case.