• vrighter@discuss.tchncs.de
                  link
                  fedilink
                  arrow-up
                  1
                  ·
                  9 months ago

                  cut out a random piece of your document. is it a partial or a complete document?

                  paste it somewhere else in the document. you have to fix the indentation because if not then the document won’t work or mean something completely different

                  • spartanatreyu@programming.dev
                    link
                    fedilink
                    arrow-up
                    1
                    ·
                    9 months ago

                    you have to fix the indentation because if not then the document won’t work or mean something completely different

                    Whitespace has no meaning in json. You can indent however you want, or not at all.

                    I’m assuming you’re running into issues because you’re writing json in a yaml file which does care about indentation, and you’re only writing json in yaml to get access to comments.

                    In which case it circles back around to: why not use toml? Whitespace formatting doesn’t corrupt the file, and it has built in comments.

        • catfish@lemmy.ml
          link
          fedilink
          arrow-up
          2
          ·
          9 months ago

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

    • brettvitaz@programming.dev
      link
      fedilink
      English
      arrow-up
      2
      arrow-down
      1
      ·
      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.

        • brettvitaz@programming.dev
          link
          fedilink
          English
          arrow-up
          1
          ·
          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.