Lab 9 - Read me

Adding appropriate documentation for your code is standard practice in any company you work for when dealing with a big, or even small project. Sometimes, code is not immediately apparent to others, and functions that one may think are pretty straight-forward, actually aren't. Setting up an environment can also be something that is very time consuming, having that type of information can cut down the time it'll take for someone to contribute to your project. As such, I added a Readme section to my project, where labs 6/7 and 8 were. I also added comments to my functions so it is clearer to others as to what the function is actually doing. I was aware of the existence of Markdown, thanks to the two terms I have spent as a coop for two different companies, it was fun to see how other students set all of their Readme sections differently. As for the reviewing part of the lab, I did so for this project, where I created a pull request to fix some typos and to add a link to their License.

Popular posts from this blog

Lab 2 - Building Firefox for Desktop from source on Windows 10

Image
Not a pretty sight if I can say so myself. After hours of waiting, seeing "Error 2" and not knowing where to go or what to do can be frustrating. But how did I get here? Relatively speaking, when following the instructions posted on  Building Firefox for Windows , everything went smoothly. Windows 10 is up to date? Check. Visual Studio 2017 is installed? Check. Rust and MozillaBuild are all installed as well? Check and check. Getting the source with Mercurial was a process that took quite a while, but that too went without any hitches. The problem came on attempting to build the code. Everything went well until we got to the image that you can see above. A Unicode error stops the building process from going ahead. When attempting to change the file "config.data", by substituting the single backslash with a double backslash on line 238, the issue still persists since the file gets rewritten every time one attempts to build. Thus far I have not found a way to
Read more

Lab 3 - Mastering your Code Editor: Sublime Text 3 and Atom

Image
Note to reader: For this lab we were tasked with working with 2 different editors. I chose Sublime Text 3  as something that I have but don't use too often and Atom , an editor I never used before. Feel free to download both as they are great editors, and feel free to take them for a spin if what you are about to read interests you! Test Driving I began by downloading the source to  the Best Resume Ever . After quickly unzipping what I had downloaded, I saw these folders and files: We were tasked with trying out two editors and performing common tasks among them, to ultimately decide which one we prefer. Below you can see the project opened in  Sublime (something done very easily, by simply going to File > Open Folder) : I did the same in Atom ( File > Open Folder): After performing some of the common tasks outlined in the lab (splitting the screen, finding strings, etc) I decided to pick Atom , since as I mentioned earlier, this editor was new to me. I
Read more

3 Things I Learned About the MIT License

Image
The task was simple. We had to first read the MIT License , followed by  The MIT License, Line by Line by Kyle E. Mitchell  and talk about what we learned or thought was interesting. One of the very first things that I learned and my main take away from this reading was to not simply trust or believe that there isn't much to a license if its writing is less than 200 words. I was impressed by just how much depth there was to the 171 word text. Secondly, I learned that the MIT License isn't one, but many (a family as a matter of fact) of licenses. And lastly, I learned that the MIT License has outlasted most of the software licensed under it.
Read more