New Concepts to be applied for the assignment

• Defining and calling a single function. This is different from the prohibition on calling/using predefined functions (last point in this list) because those functions have been written by someone else. For this assignment you will the one who will be writing the instructions (defined inside the body of a function).
• Declaring and using variables that are local to a function.
• If you want credit for your work: Do not use any pre-created functions/methods unless you are given explicit permission to do so. [Generic list of allowable pre-created code in the form of python libraries]

Only new concepts that need to be applied in the assignment are listed, concepts previously applied in other assignments may need to used in the implementation of your solution.

Functional assignment requirements

Up to this point you have only been using functions that have already been defined with the Python programming language such as: print() and input(). For this assignment you will be defining  (writing the body) of a new function called revealName(). JT's hint: knowing your terminology is always important before starting an assignment. It is imperative that you complete this prerequisite work for this particular assignment (studying the concepts in the 'decomposition/functions' lectures, trying to apply those concepts as well as learning the necessary terminology) otherwise you will have trouble understanding the following requirements.

• Implement a function called revealName().

  • When called this function will:

    • Prompt the user to enter their full name by calling the pre-created python input() function. (Worth 1.0 GPA)

      • The user's input must be stored in a variable that is local to revealName and not in a global variable. (Worth 1.0 GPA)

    • Echo back the name that user entered by calling the  pre-created python print() function. (Worth 1.0 GPA)

• Example run of a my solution:

• Implement a starting function for your program in the fashion that you have been shown in functional decomposition lectures. This function will be the starting execution point of your program so it must be called start() or main().

  • The starting function will contain only a single instruction, the call to run the function revealName(). (Worth 0.5 GPA)

• The final instruction needed is the call to run the starting function. It will be outside the body of any of the above two functions and it will be the only python instruction that is outside the body of a function. (Worth 0.5 GPA)

How to do determine 'how you did' on an assignment?

Program functionality (implementing working program features)

• Test your program: Because the assignment description (along with required features) is posted ahead of time if you test your program thoroughly before submitting the final version then you should get a pretty clear idea of "how you will do".

Non -functional assignment requirements (style and documentation).

Although it won't affect your grade for mini-assignments you should still practice applying good style in your solution as well as writing documentation. It will keep your skills for the full assignments (when you will be graded on these things) and get you used to having good habits.

• Naming conventions: You should employ good naming conventions for identifiers (variables and constants) as covered in the "Introduction to programming" section of the course.
• Named constants should be used as appropriate.
• Python documentation: This should be specified in the header of the program (very top of your program in the form of Python documentation). The basics of documentation were covered in the "Intro to programming" section of the course. Later sections may include additional details.
  • Identifying information: All assignments should include contact information (full name, student ID number and tutorial section [Here's a Link if you don't know how to find this information]) at the very top of your program.
  • Program version. (version date or version number).
    • Under the version you should specify which assignment features were implemented in that version. An example covering the use of program versioning and documentation was covered in the "Introduction to programming" lectures.
  • Any program limitations or weaknesses.
• In general: The program output and the program code itself (python program) must be properly aligned and formatted including whitespace as needed to group related parts and separate sections (which again was covered in the "Intro to programming" lectures of the course. Additional requirements in the formatting of output may be included in the "Functional requirements" section of the assignment.
• Finally your program should follow the 5 rules of thumb for designing software (Jakob Nielsen's 10 usability heuristics) which were included at the notes on 'Repetition' e.g. prompts to the user to enter the required information should be clear to the user as to what is required, good error messages should be provided for erroneous input etc.

Marking and grading

• What to submit (remote learning version): If your submission won't run using Python 3.x on any computer then it won't be awarded credit. It's up to you if you wish use the graphical program builder other than IDLE (or another development environment rather than a simple text editor) to write/run your programs but if you do you submit your program in the form of text ".py" file or files. Windows users: take care that you don't accidentally submit a shortcut to a file instead of the actual file. (Check the file name and compare the file size to your original file. Simply downloading the shortcut file as a test won't work because that shortcut will work on your computer but not on anyone else's machine and this may mean your work won't be graded.) 

• Naming the file containing your program: You must save your program in a file called "firstFunction.py". Failing to use this exact name will affect your grade (-0.2 GPA).

• Questions or concerns about grades after they have been released: Assignments will be marked by your tutorial instructor (the "Teaching Assistant" or "TA") for your tutorial section. When you have questions about marking this is the first person that you should be directing your questions towards.  If you still have question after you have talked to your TA, then you can talk to your course (lecture) instructor but please indicate in your email that you first contacted your TA before going into your concerns.

• Late assignments or components of assignments/Assignment extensions: Normally due dates are strict and extensions require documentation. Due to the likelihood of widespread Covid related illnesses late penalties will not be applied this semester. But if you do submit something after the due date/time then you should email your marker (TA in the tutorial that you are officially registered) so that person will know to look for it in D2L. Also if are submitting too many graded components late however this doesn't bode well for your performance in this course so you may be referred to the associate dean of undergraduate students (faculty of science) and she may contact you regarding your course work.

• How you will be graded for mini-assignments.  Similar to many mini-assignments the grading is simple and doesn't require a separate spreadsheet. Instead you can look in D2L  under Assessments->Dropbox and then clicking on the appropriate assignment link.

Collaboration:

Assignments must reflect individual work; group work is not allowed in this class nor can you copy the work of others. Some "do nots" for your solution: don't publically post it, don't email it out, don't show it to other students.  For more detailed information as to what constitutes academic misconduct (i.e., cheating) for this course please read the following [link].

Method of submission:

You are to submit your assignment using D2L [help link]. Make sure that you [check the contents of your submitted files] (e.g., is the file okay or was it corrupted, is it the correct version etc.). It's your responsibility to do this! (Make sure that you submit your assignment with enough time before it comes due for you to do a check). If don't check and there were problems with the submission then you should not expect that you can "learn your lesson" and simply resubmit.

D2L configuration for this course

• Do not use compression utilities (such as zip) or archiving utilities (such as tar) otherwise your submission may not be marked. The space savings in D2L is not worth the extra time required by the marker to process each submission.
• How often can you submit: Multiple submissions are allowed for this assignment: You can (and really should) submit work as many times as you wish before the due date. However only the latest file submitted is the one that will be marked, everything else will be ignored (because it is not fair to your marker to sort through multiple versions of your files).
• What to submit: Python programs only (file name ends in .py)  Any other type of file will be rejected by D2L.

(Waived for fall 2022), Late submissions for full assignments  when there is no extension granted: Make sure you give yourself enough time to complete the submission process so you don't get cut off by D2L's deadline (or your submission will be automatically flagged as late by D2L and it will be graded appropriately)..

General use of pre-created Python libraries:

Unless otherwise told you are to write the code yourself and not use any pre-created functions (or methods). For most assignments the usual acceptable functions include: print(), input() and the 'conversion' functions such as int(), float(), str(). Look at the particular assignment description for a list of other functions/methods that you are allowed to use and still get credit in an assignment submission. If it's not listed then you should assume that you won't be able use the function and still be awarded credit.