Skip to content

Generate @Help parameter documentation from sys.all_parameters (kills doc drift) #620

Description

@nanoDBA

Problem

The @Help = 1 parameter documentation in both procedures is hand-maintained text. It has drifted from the real signature repeatedly — a recent audit found six stale-parameter references of exactly this class.

Fix

Generate the parameter table in @Help output from sys.all_parameters at runtime (name, type, default where determinable), keeping only per-parameter description text as authored content keyed by parameter name. A description row with no matching real parameter (or vice versa) becomes structurally impossible to ship silently — a startup assertion can flag the mismatch.

Pattern source: DarlingData help sections, which are driven from the catalog so help cannot disagree with the procedure signature.

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

    code-qualityRefactoring, dead code removal, maintainability, or internal correctnessenhancementNew feature or requestp3-nice-to-haveLow-impact enhancement or minor improvement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions