Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 28 additions & 2 deletions ipa/general/0100.md → ipa/general/0100.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ language.

## Guidance

<Guidelines>

<Guideline id="IPA-0100-must-use-american-english" given="spec" lintable>

API producers **must** use American English across the API.

This includes but is not limited to:
Expand All @@ -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/).

:::

<Example.Correct>

```yaml
properties:
status:
type: string
enum:
- CANCELED
- COMPLETED
```

<Example.Reason>
Uses the American English spelling "canceled" (one "l") in the enum value.
</Example.Reason>

</Example.Correct>

</Guideline>

</Guidelines>

## Further Reading

[MongoDB Meta Documentation](https://www.mongodb.com/docs/meta/style-guide/terminology/general-term-guidelines/use-consistent-terms/#use-consistent-terminology)
6 changes: 5 additions & 1 deletion src/components/ipa/Guideline/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ export function Guideline({
{isInsideGuidelines && <NumberCircle />}
<div className={styles.content}>
<GuidelineHeader />
<div className={styles.body}>{children}</div>
{/* `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. */}
<div className={clsx(styles.body, "markdown")}>{children}</div>
<GuidelineFooter />
</div>
</Root>
Expand Down
Loading