Skip to content

Fix minor spelling and grammatical errors in student_errors documentation #734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Geethz-Dev wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix minor spelling and grammatical errors in student_errors documentation #734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f9e8a6
Fix minor spelling and grammatical errors in student_errors documenta…
Geethz-Dev Feb 27, 2026
776933a
Fix minor typos and formatting inconsistencies in testing_networks do…
Geethz-Dev Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions _docs/student/student_errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ title: Debugging Submitty Output

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

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

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

![](/images/killSignal.png)

### Segmentation Fault

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

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

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

There are other reasosn for SegFaults but these are very common examples.
There are other reasons for SegFaults but these are very common examples.
However what ever the reason DrMemory/Valgrind and gdb are excellent tools to
help with more advanced errors if print debugging isn't cutting it.
6 changes: 3 additions & 3 deletions _docs/student/testing_networks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: Testing Networked Applications Locally
We are currently hosting the docker images that will be used for grading on the
[Docker Hub](https://hub.docker.com/u/submitty/).

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

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

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

Then, you can connect your containers to the network as follows:
```
Expand Down