Dyalog / Dyalog/documentation-guidelines

"example" and "examples" should be capitalised

Open
#6 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Dockerfile
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

https://github.com/Dyalog/documentation-guidelines/blob/trunk/docs/style.md#examples says

> Introduce full examples with:
>```md
> example (or examples)
> { .example}
>```

but should probably say

> Introduce full examples with:
>```md
> Example (or Examples)
> { .example}
>```

and so on.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.