Comment on Everything about TOML format - Orchard Dweller

• Quetzalcutlass@lemmy.world ⁨9⁩ ⁨months⁩ ago

  I’ve seen them included as part of the data.

  “//”, “Comment goes here”,

  source

  • spartanatreyu@programming.dev ⁨9⁩ ⁨months⁩ ago

    That doesn’t really work when you need two comments at the same level, since they’d both have the same key

    source

    • vrighter@discuss.tchncs.de ⁨9⁩ ⁨months⁩ ago

      write json with comments. Use a yaml parser.

      source

      • spartanatreyu@programming.dev ⁨9⁩ ⁨months⁩ ago

        If you’re reaching for yaml, why not use toml?

        source

        • -> View More Comments
    • catfish@lemmy.ml ⁨9⁩ ⁨months⁩ ago

      It still works since multiple identical keys are still valid json. Although that in itself isn’t fantastic imo.

      source
• brettvitaz@programming.dev ⁨9⁩ ⁨months⁩ ago

  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.

  source

  • spartanatreyu@programming.dev ⁨9⁩ ⁨months⁩ ago

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

    source

    • brettvitaz@programming.dev ⁨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.

      source