Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 06:36:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/style/optioncaption-required-and-matches-membercount.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.8 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
style
optioncaption
option
member-count
aa0221
aa0223
aa0224
al
w1
all

Option fields need OptionCaption, and its element count must match OptionMembers (CodeCop AA0221/AA0223/AA0224)

Description

CodeCop AA0221 requires an OptionCaption on every option-type field that is not sourced from a table column (table-sourced option fields inherit the captions of the underlying field). AA0223 and AA0224 add two integrity checks: the number of comma-separated entries in OptionCaption must equal the number of entries in OptionMembers, and each caption must align by position with its member. The position alignment is what the platform uses to translate option values — the OptionMembers list never changes per locale, the OptionCaption list does. A mismatch in count or order produces silent corruption: the option Released shows the caption that belongs to Pending, and the bug is locale-dependent.

Best Practice

OptionMembers = Open,Released,Pending; and OptionCaption = 'Open,Released,Pending'; — same count, same order. When adding a new member, update both lines in the same commit.

See sample: optioncaption-required-and-matches-membercount.good.al.

Anti Pattern

OptionMembers = Open,Released,Pending; with no OptionCaption at all (the user sees the raw English members and translation is impossible), or OptionMembers = Low,Medium,High,Critical; paired with OptionCaption = 'Low,Medium,High'; — count mismatch, Critical displays as blank or carries the wrong caption depending on platform version.

See sample: optioncaption-required-and-matches-membercount.bad.al.