From 25b664bc12f129aa0f44fb9bd4421140ba526b7c Mon Sep 17 00:00:00 2001
From: Greg Wilson <gvwilson@third-bit.com>
Date: Tue, 13 Jan 2015 09:04:04 -0500
Subject: [PATCH] Minor grammatical fixes to FAQ and LAYOUT
---
FAQ.md | 7 ++++---
LAYOUT.md | 20 +++++++++++++++-----
2 files changed, 19 insertions(+), 8 deletions(-)
diff --git a/FAQ.md b/FAQ.md
index 063aec2..5514c7c 100644
--- a/FAQ.md
+++ b/FAQ.md
@@ -30,14 +30,15 @@
* `discussion`: marks issues used for conversations about specific problems and questions
* `duplicate`: marks an issue that was closed as redundant (include the number of the original issue in the closing comment)
* `enhancement`: asks for, or adds, a new feature or new information
- * `filed-by-newcomer`: issue or pull request was filed by someone who is relatively new to GitHub and/or this project, and would appreciate guidance as well as feedback
+ * `filed-by-newcomer`: issue or pull request was filed by someone who is relatively new to GitHub and/or this project,
+ and would appreciate guidance as well as feedback
* `getting-started`: issue or pull request is suitable for someone new to GitHub and/or this project
* `help-wanted`: a question or request for assistance
* `left-as-was`: marks an issue closed because the item in question will be left as it was
* `suitable-for-newcomer`: issue or pull request is a good starting point for someone who is relatively new to GitHub and/or this project
* `work-in-progress`: a pull request that is not yet ready for review
-* *How create non-Python input cells?*
+* *How can we create input cells for particular languages?*
Use
@@ -46,7 +47,7 @@
~~~
where `lang` is `bash` for the Unix Shell, `r` for R, `matlab` for MATLAB,
- `sql` for SQL. For a full list, check
+ `python` for Python, and `sql` for SQL. For a full list, check:
~~~
$ pandoc -v
diff --git a/LAYOUT.md b/LAYOUT.md
index 463465a..1255899 100644
--- a/LAYOUT.md
+++ b/LAYOUT.md
@@ -223,25 +223,32 @@ Each topic page must be structured as follows:
Nothing else should be marked as bold text --- use *italics* for
for all other emphasis.
-5. For Unix Shell commands use
+5. When laying out source code, use `{.lang}` as a style on the
+ opening `~~~` line. For Unix Shell commands use:
~~~ {.bash}
$ some-command
~~~
- For R code use
+ For MATLAB use:
+
+ ~~~ {.matlab}
+ some code
+ ~~~
+
+ For R use:
~~~ {.r}
some code
~~~
- For MATLAB code use
+ For Python use:
- ~~~ {.matlab}
+ ~~~ {.python}
some code
~~~
- For SQL code use
+ For SQL use:
~~~ {.sql}
some code
@@ -278,6 +285,9 @@ be laid out like this:
as it is simpler and prettier than alternatives like
[reveal.js](http://lab.hakim.se/reveal-js/).
+3. For examples of slideshows, please see the
+ [slideshow repository](https://github.com/swcarpentry/slideshows).
+
## Reference Guide
The reference guide is a cheat sheet for learners to print, doodle on,
--
GitLab