Dyalog / Dyalog/documentation-guidelines

Examples description is incorrect

Open
#7 0 comments 0 reactions 1 assignee Claimed by @xpqz View on GitHub
Dominant language
Dockerfile
Stars
2
Forks
2
PR merge metrics
No merged PRs in 30d

Description

The examples section is incorrect and the instructions doesn't work in the real documentation. The .example class is for backwards compatibility. Examples are either semantically significant (use a normal heading and a better name than "Example"), or not (just introduce it as part of the text). If you absolutely want to use a heading called "Example", use the .example class on the heading. This excludes it from the ToC.

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.