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