aws-doc-sdk-examples icon indicating copy to clipboard operation
aws-doc-sdk-examples copied to clipboard

Metadata: non-localizable text in descriptions must be marked as noloc or code

Open Laren-AWS opened this issue 10 months ago • 0 comments

Non-loc text like code entities must be wrapped in <noloc> or <code> tags so that it's not localized. Here's an example:

Before

description: Use case #4: EQUAL operator on DICOMSeriesInstanceUID. 

After

description: Use case #4: <code>EQUAL</code> operator on <code>DICOMSeriesInstanceUID</code>.

Note: code renders as monospace text, while noloc has no visual effect.

This is not something we've paid attention to, so it's likely spread throughout our metadata and will require a full audit and update.

Laren-AWS avatar Apr 19 '24 21:04 Laren-AWS