Skip to content

Commit 4c5082f

Browse files
Geethz-Devbmcutler
andauthored
[Bugfix:Documentation] spelling and grammatical errors (#734)
Corrected minor spelling and grammatical errors to improve clarity in the student_errors documentation. --------- Co-authored-by: Barb Cutler <bmcutler@users.noreply.github.com>
1 parent 694ef08 commit 4c5082f

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

_docs/student/student_errors.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@ title: Debugging Submitty Output
88

99
Your code is not tested locally first, Submitty should be used as the
1010
final submission server, not as a debugger. Before submitting anything
11-
make sure that you are able to run your code locally without error.
11+
make sure that you are able to run your code locally without errors.
1212
In addition the instructor may decide to use hidden tests which still
1313
reveal the grade. Often these tests check corner cases and exactly what those
1414
could vary by your program but common cases to consider are positive,
15-
negative, zero, and floating point values and how your code performs give
15+
negative, zero, and floating point values and how your code performs given
1616
unexpected but valid input.
1717

1818
Often times there may be a missing punctuation or small typo in the output
@@ -45,21 +45,21 @@ perform operations slower than hashmaps or trees-like structures. If your code
4545
gets a kill signal and you are using specific data structures be sure you are
4646
using them correctly
4747

48-
If you are using python, ineffeicant use of dictionaries, and sets can cause this error to occur.
48+
If you are using python, inefficient use of dictionaries, and sets can cause this error to occur.
4949

5050
![](/images/killSignal.png)
5151

5252
### Segmentation Fault
5353

5454
For anyone who has ever programmed in a language with explicit memory management such as C/C++
55-
you are probably familiar with the infamous and seemingly unhelpful error know as Segmentation Fault.
55+
you are probably familiar with the infamous and seemingly unhelpful error known as Segmentation Fault.
5656
In short however a SegFault is the result of a memory access violation.
5757

5858
This can occur for a number of reasons, first case we will look at is going out of bounds.
5959
If while iterating over a list your index is out of the range of the list this can
6060
result in a memory SegFault.
6161

62-
Another possibly is when using pointers, if a pointer on the stack is initialzied to NULL
62+
Another possibility is when using pointers, if a pointer on the stack is initialzied to NULL
6363
or never initialized in the first place but you try to dereference it this is the same thing
6464
as a NUllPointerException in Java and is a very common issue when dealing with pointers
6565
which are commonly found when dealing with Tree structures and and linked lists.
@@ -70,6 +70,6 @@ but since submitty is a teaching tool lets assume the problems given are
7070
not so large that you run out of memory trying to solve it. A common example
7171
of this is infinite recursion. Make sure the base case is eventually called.
7272

73-
There are other reasosn for SegFaults but these are very common examples.
73+
There are other reasons for SegFaults but these are very common examples.
7474
However what ever the reason DrMemory/Valgrind and gdb are excellent tools to
7575
help with more advanced errors if print debugging isn't cutting it.

_docs/student/testing_networks.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Testing Networked Applications Locally
99
We are currently hosting the docker images that will be used for grading on the
1010
[Docker Hub](https://hub.docker.com/u/submitty/).
1111

12-
You can can "pull" the most recent submitty images using the commands:
12+
You can "pull" the most recent submitty images using the commands:
1313
```
1414
docker pull submitty/python:2.7
1515
docker pull submitty/python:3.6
@@ -34,7 +34,7 @@ docker create -i -t -v SOURCE_CODE_DIRECTORY:SOURCE_CODE_DIRECTORY -w SOURCE_COD
3434
``-i`` boots the container in interactive mode, allowing submitty to pipe standard
3535
input to the containers.
3636

37-
``-t`` Allocates a pseudo-TTY so that you can interact with your container.
37+
``-t`` allocates a pseudo-TTY so that you can interact with your container.
3838

3939
``-v`` mounts a directory on the host machine so that output persists after the
4040
docker exits. ``SOURCE_CODE_DIRECTORY:SOURCE_CODE_DIRECTORY`` specifies first
@@ -61,7 +61,7 @@ Once you have created a few containers, you can create a network with this comma
6161
```
6262
docker network create --driver bridge NETWORK_NAME
6363
```
64-
Where you can specify your own network_name.
64+
You can specify your own network_name.
6565

6666
Then, you can connect your containers to the network as follows:
6767
```

0 commit comments

Comments
 (0)