From 57d164559b84a3908d99d934e7fd5b2ceed2f16d Mon Sep 17 00:00:00 2001 From: EdmundGoodman Date: Mon, 10 May 2021 23:01:59 +0100 Subject: [PATCH] Fixed typos --- CONTRIBUTING.md | 8 ++------ README.md | 10 +++------- cs126/part10.md | 3 +-- index.md | 10 +++------- 4 files changed, 9 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a8de56c..ca20eb3e 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,7 +25,7 @@ To ensure the smooth running of the this project, and avoid any contributions ha - Please do not re-host any university owned content, including but not limited to past papers and lecture notes ### How do I display Math? -Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. Otherwise, add it into the front matter, then make sure you wrap the math in `$$`. +Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. If it's not there, add it into the front matter. For math sections (ensure that there's a new line before and after the start and end `$$` respectively): ``` @@ -34,11 +34,7 @@ $$ $$ ``` -or for in-line math: - -``` -$$1+1=2$$ for in-line math -``` +or `$$1+1=2$$` for in-line math If there is no YAML Front Matter you can add it at the top of the file like this: ``` diff --git a/README.md b/README.md index 4b5886b6..eb128c1c 100755 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ If you've been linked to this site, you've probably also seen us asking for anyo 1. Our course isn't marked on a curve, so others using your notes to get better doesn't detriment you 2. Making notes is a great way to revise, as it makes sure you properly understand the content, and if you know you’re putting them somewhere it gives you accountability to actually get them done -3. Any content that is contributed is great to have - it doesn't have to be perfect! The beauty of these type of projects is that it inherently allows collaboration, so we can work together to improve any problems you think might be present +3. Any content that is contributed is great to have - it doesn't have to be perfect! The beauty of these types of projects is that they inherently allow collaboration, so we can work together to improve any problems you think might be present 4. Having experience collaborating on an open source project through tools like Git is a really useful skill and is a lot more exciting than what we did with it in CS133, and being able give this as an example of where you've done it in practice could be a cool thing to put on your CV 5. You'll get a neat icon of you in the contributors section of the README and index pages! @@ -65,7 +65,7 @@ To ensure the smooth running of the this project, and avoid any contributions ha - Please do not re-host any university owned content, including but not limited to past papers and lecture notes ### How do I display Math? -Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. Otherwise, add it into the front matter, then make sure you wrap the math in `$$`. +Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. If it's not there, add it into the front matter. For math sections (ensure that there's a new line before and after the start and end `$$` respectively): ``` @@ -74,11 +74,7 @@ $$ $$ ``` -or for in-line math: - -``` -$$1+1=2$$ for in-line math -``` +or `$$1+1=2$$` for in-line math If there is no YAML Front Matter you can add it at the top of the file like this: ``` diff --git a/cs126/part10.md b/cs126/part10.md index 020468ae..3098dbc0 100755 --- a/cs126/part10.md +++ b/cs126/part10.md @@ -75,7 +75,7 @@ nex: part11 - AVL trees are a concrete implementation of self-balancing binary search tree - Insertion and deletion operations re-arrange the tree to ensure it remains balanced - - Named after its creators, Adelson, Velsky and Landis + - Named after its creators, Adelson-Velsky and Landis - Other self-balancing binary search trees exist, such as red-black trees, but this is a common approach to implementing such an ADT - Requirements to be a self-balancing binary search tree @@ -98,7 +98,6 @@ nex: part11 - Deletion - - Performance - In all cases, the space complexity is $$O(n)$$ diff --git a/index.md b/index.md index c32a4f02..2c8ea6c7 100755 --- a/index.md +++ b/index.md @@ -10,7 +10,7 @@ If you've been linked to this site, you've probably also seen us asking for anyo 1. Our course isn't marked on a curve, so others using your notes to get better doesn't detriment you 2. Making notes is a great way to revise, as it makes sure you properly understand the content, and if you know you’re putting them somewhere it gives you accountability to actually get them done -3. Any content that is contributed is great to have - it doesn't have to be perfect! The beauty of these type of projects is that it inherently allows collaboration, so we can work together to improve any problems you think might be present +3. Any content that is contributed is great to have - it doesn't have to be perfect! The beauty of these types of projects is that they inherently allow collaboration, so we can work together to improve any problems you think might be present 4. Having experience collaborating on an open source project through tools like Git is a really useful skill and is a lot more exciting than what we did with it in CS133, and being able give this as an example of where you've done it in practice could be a cool thing to put on your CV 5. You'll get a neat icon of you in the contributors section of the README and index pages! @@ -71,7 +71,7 @@ To ensure the smooth running of the this project, and avoid any contributions ha - Please do not re-host any university owned content, including but not limited to past papers and lecture notes ### How do I display Math? -Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. Otherwise, add it into the front matter, then make sure you wrap the math in `$$`. +Firstly, ensure that the top of the markdown (.md) file has YAML Front Matter containing the key-value pair `math: true`. If it's not there, add it into the front matter. For math sections (ensure that there's a new line before and after the start and end `$$` respectively): ``` @@ -80,11 +80,7 @@ $$ $$ ``` -or for in-line math: - -``` -$$1+1=2$$ for in-line math -``` +or `$$1+1=2$$` for in-line math If there is no YAML Front Matter you can add it at the top of the file like this: ```