Programming

17313 readers

206 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 1 year ago

MODERATORS

[email protected]

Everything about TOML format - Orchard Dweller (www.youtube.com)

submitted 9 months ago by [email protected] to c/[email protected]

49 comments fedilink hide all child comments

Visualizer:
- https://toml-to-json.orchard.blog/
Code:
- https://github.com/orcharddweller/tom...
TOML spec:
- https://toml.io/en/v1.0.0

you are viewing a single comment's thread
view the rest of the comments

[–] [email protected] 1 points 9 months ago (1 children)

For settings files I always have an example file with sensible values filled in and along with descriptive keys that serves as reasonable documentation. If something is truly unknowable, I’ve probably done something wrong.

[–] [email protected] 2 points 9 months ago (1 children)

How would you mark a flag in your json settings file as deprecated?

[–] [email protected] 1 points 9 months ago

In my opinion, the settings file isn’t where this information should be presented. I would put these notes in the release log and readme and example settings file. I have also written this information to logging during startup so a user knows what to do, or I write a migration that does the change automatically if that’s possible.

This is only my opinion and you can use the comment method described like “//“: “Deprecated” if desired.