Apply doc fixes suggested by @rossbar in #121

executablebooks · Mar 28, 2020 · 95a0404 · 95a0404
1 parent 77af8e1
commit 95a0404
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/develop/test_infrastructure.md b/docs/develop/test_infrastructure.md
@@ -12,7 +12,7 @@ The tests are run using [pytest](https://docs.pytest.org)/[GitHub Actions](https
 
 The tests are ordered in a hierarchical fashion:
 
-1. In `tests/test_commonmark` the [CommonMark](https://github.com/commonmark/CommonMark.git) test set is run; to check that the parser is complying with the CommonMark specification.
+1. In `tests/test_commonmark` the [CommonMark](https://github.com/commonmark/CommonMark.git) test set is run to check that the parser is complying with the CommonMark specification.
 2. In `tests/test_renderers` are tests that check that the Markdown AST is being correctly converted to the docutils/sphinx AST. This includes testing that roles and directives are correctly parsed and run.
 3. In `tests/test_sphinx` are tests that check that minimal sphinx project builds are running correctly, to convert MyST markdown files to HTML.
 4. In `.circleci` the package documentation (written in MyST format) is built and tested for build errors/warnings.

diff --git a/docs/index.md b/docs/index.md
@@ -10,7 +10,7 @@ MyST syntax and {doc}`Sphinx <sphinx:intro>`. This allows for native markdown su
 directives.
 
 ```{warning}
-The MyST parser is in an alpha stage, and may have breaking syntax to its implementation
+The MyST parser is in an alpha stage, and may have breaking changes to its implementation
 and to the syntax that it supports. Use at your own risk. If you find any issues,
 please report them
 [in the MyST issues](https://github.com/ExecutableBookProject/meta/issues/24)

diff --git a/docs/using/syntax.md b/docs/using/syntax.md
@@ -450,7 +450,7 @@ print('yep!')
 ## Roles - an in-line extension point
 
 Roles are similar to directives - they allow you to define arbitrary new
-functionality in Sphinx, but they are use *in-line*. To define an in-line
+functionality in Sphinx, but they are used *in-line*. To define an in-line
 role, use the following form:
 
 ````{list-table}
@@ -600,8 +600,8 @@ This is the best equation {eq}`eqn:best`
 ### Front Matter
 
 This is a YAML block at the start of the document, as used for example in
-[jekyll](https://jekyllrb.com/docs/front-matter/). Sphinx intercepts this data and
-stores it within the global environment (as discussed
+[jekyll](https://jekyllrb.com/docs/front-matter/). Sphinx intercepts these data and
+stores them within the global environment (as discussed
 [here](https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html)).
 
 A classic use-case is to specify 'orphan' documents, that are not specified in any
@@ -634,7 +634,7 @@ Is below, but it won't be parsed into the document.
 % my comment
 
 ````{important}
-Since comments are a block level entity, they will terminate the previous block.
+Since comments are a block-level entity, they will terminate the previous block.
 In practical terms, this means that the following lines
 will be broken up into two paragraphs, resulting in a new line between them: