Skip to content

Commit

Permalink
[v3] Update Markdown files to latest spec (#154)
Browse files Browse the repository at this point in the history
* [v3] Add level one headings to Markdown files.

All Markdown files should, from this point on, start with a level one heading.
See exercism/configlet#150 for the rationale behind these changes.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).

* [v3] Markdown sub-headings must be parent level incremented by one.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).
  • Loading branch information
ErikSchierboom authored May 4, 2021
1 parent 1d54dc4 commit 94d9bbd
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Every exercise must have at least these files:
- `test.sml`: Test suite
- `testlib.sml` Test helper

#### `testlib.sml`
### `testlib.sml`

This helper has this structures:

Expand Down
2 changes: 2 additions & 0 deletions docs/ABOUT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# About

[Standard ML (SML)](https://en.wikipedia.org/wiki/Standard_ml) is one of the two main dialects of the ML programming
language. [ML](https://en.wikipedia.org/wiki/ML_programming_language) was the first strong statically typed language,
developed in the early 1970s at the University of Edinburgh.
Expand Down
2 changes: 2 additions & 0 deletions docs/LEARNING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Learning

## Recommended Learning Resources

Exercism provides exercises and feedback but ML can be difficult to jump into for those learning SML for the first time.
Expand Down
2 changes: 2 additions & 0 deletions exercises/practice/bob/.meta/description.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Description

Bob is a lackadaisical teenager. In conversation, his responses are very limited.

Bob answers 'Sure.' if you ask him a question.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Hints
# Hints

You can think of this data structure as a [`Rose Tree`](https://en.wikipedia.org/wiki/Rose_tree). You are given a data type `'a tree` that represents this data structure.

Expand Down
2 changes: 1 addition & 1 deletion exercises/practice/nth-prime/.docs/instructions.append.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Hints
# Hints

If the argument is not less than `1` raise the exception [`Domain`](http://sml-family.org/Basis/general.html#SIG:GENERAL.Domain:EXN).

Expand Down

0 comments on commit 94d9bbd

Please sign in to comment.