diff --git a/ipa/general/0100.md b/ipa/general/0100.mdx similarity index 69% rename from ipa/general/0100.md rename to ipa/general/0100.mdx index 0ac5c89..f94d0f7 100644 --- a/ipa/general/0100.md +++ b/ipa/general/0100.mdx @@ -12,6 +12,10 @@ language. ## Guidance + + + + API producers **must** use American English across the API. This includes but is not limited to: @@ -21,13 +25,35 @@ This includes but is not limited to: - Descriptions - Enum values -**Example:** “canceled” over -[cancelled](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createBackupExportJob). +:::note The MongoDB Style Guide uses the Merriam-Webster’s Collegiate Dictionary. 11th ed. Springfield, MA: Merriam-Webster, 2003. Continually updated at [https://www.merriam-webster.com/](https://www.merriam-webster.com/). +::: + + + +```yaml +properties: + status: + type: string + enum: + - CANCELED + - COMPLETED +``` + + + Uses the American English spelling "canceled" (one "l") in the enum value. + + + + + + + + ## Further Reading [MongoDB Meta Documentation](https://www.mongodb.com/docs/meta/style-guide/terminology/general-term-guidelines/use-consistent-terms/#use-consistent-terminology) diff --git a/src/components/ipa/Guideline/index.tsx b/src/components/ipa/Guideline/index.tsx index 6de7733..5b94513 100644 --- a/src/components/ipa/Guideline/index.tsx +++ b/src/components/ipa/Guideline/index.tsx @@ -28,7 +28,11 @@ export function Guideline({ {isInsideGuidelines && }
-
{children}
+ {/* `markdown` makes children inherit Docusaurus' markdown vertical + rhythm (heading/paragraph/list/admonition spacing), since the + `.markdown > *` rules only match direct children of a markdown + container. */} +
{children}