Skip to content

Should John Smith, MD - PhD split its suffixes without a declared delimiter, and can suffix_delimiter be deprecated? #889

Open

Description

@derek73

Background. suffix_delimiter (#156, 1.x) and Policy.extra_suffix_delimiters (2.0) let a caller declare a separator between post-nominals, such as RN - CRNA. The v1 setting is the HumanName keyword and the Constants attribute, and the facade layers it onto the Policy field. Since then the default has learned most of what the knob was for: the comma tail's credential run, joined credentials (#887, MD/PhD, MD-PhD), and ; as a default delimiter after the first comma (#871).

What the default does today, measured on master, compared with a declared delimiter:

Input Default Declared delimiter
John Smith, MD - PhD given John, family Smith, suffix MD - PhD suffix MD, PhD (" - ")
John Smith, M.D. - Ph.D. suffix M.D. - Ph.D. suffix M.D., Ph.D. (" - ")
John Smith, MD - Chief of Surgery title Chief of Surgery, suffix MD - suffix MD (" - ")
John Smith, MD / PhD suffix MD / PhD suffix MD, PhD (" / ")
John Smith, MD | PhD suffix MD | PhD suffix MD, PhD (" | ")
John Smith, MD & PhD suffix MD & PhD suffix MD, PhD (" & ")

So the fields come out right by default, which was #156's request. The knob still does two things:

  • it splits the suffix into separate entries (MD, PhD rather than MD - PhD);
  • it drops a stray separator when something other than a credential follows (MD - → MD).

Questions

  1. Should -, /, | and & be default suffix delimiters after the first comma, the way Read a semicolon between post-nominals as a comma (D15) #871 made ; one? That gives the default both of the knob's remaining effects.
  2. If question 1 lands, should suffix_delimiter and extra_suffix_delimiters be deprecated in 2.7, with a DeprecationWarning naming what to use instead, and removed in 3.0? That would add an entry to decisions/3-0-reevaluations. Removing them in a minor release would break callers who set them, so deprecation comes first.
  3. Is there a separator a caller would still need to declare once these are defaults? If so, the knob stays and only its docs change.

Not in scope: MD;; PhD (a doubled separator), the full-width ;, and spaced hyphenated surnames as data cleanup (#820).

Activity

  1. added this to the 2.7 milestone on Oct 25, 2026
  2. self-assigned this
    on Oct 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions