Skip to content

The Opting out table lists only enabled: false for the server-wide switch #42

Open

Description

@dmccoystephenson

The README "Opting out" table lists only enabled: false for the server-wide switch, but the code also accepts other spellings.

Where: README.md, the server-wide row of the "Opting out" table. parseServerWideConfig passes the enabled: value to isOff, which trims, lowercases and accepts off, false, 0 and no. serverWideConfig_acceptsEverySpellingOfOff pins false, no, 0, off, OFF and No. The environment row of the same table already lists its spellings, so an operator reading the table cannot tell that enabled: off works.

Suggested wording: "enabled: false (or off, 0, no, case-insensitive) in plugins/trace/config.yml".

The class Javadoc and the Builder.serverWideConfig Javadoc are corrected in the Stage A documentation PR from the same session. The README row is left out of that PR because the "Opting out" section is user-facing disclosure wording on the do-not-auto-merge list, so the change needs maintainer approval.

Related: #15, which would add quoted spellings to the list if it is resolved that way.

This issue was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions