Assignments
- Assignment 0: Setting Up Your System
- Assignment 1: Ruby One-Liners
- Assignment 2: Command-line app, and basic ActiveRecord
- Assignment 2B (optional!): Adding ActiveRecord to Assignment 2
- Assignment 3: MetricsMine
- Assignment 3, Milestone II (not to be handed in)
- Assignment 3, Milestone III - due Sunday, Dec. 7
- Assignment 4: Final project - Proposal due Dec. 11!
- Final Project Ideas and Brainstorming
- Final Project Tips and Features
- And . . . Quizzes, exercises, participation, etc.
blog comments powered by Disqus
Add New Comment
Viewing 17 Comments
Thanks. Your comment is awaiting approval by a moderator.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Is there draft copy of Assignment 3 has been posted. I am having a hard time to find it.
Thank you
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
For Assignment 2: Review what we say in instructions/rdoc/index.html -- We have tried to be clear. Did you read it?
Here's what we say for Assignment 2.
Along the way, add whatever documentation is appropriate internally. Internal documentation should note concisely anything fancy, clever, interesting, or hard to understand.
Before submitting, you will write a file called readme.txt for the root of the project. It must describe what you did, in particular how you tackled the hand evaluation methods in the Hand class. We have put a very short readme.txt in place to get you started. More on the readme.txt below.
Internal documentation and writeup (the readme.txt). Is the internal documentation concise but clarifying? Does the readme.txt explain to me, in sentences and paragraphs, how your code works?
NOTE: There is no need to write things like "The Card class represents a playing card." Please, do not state the obvious. If you feel that you need to address this briefly, you may, but do not repeat the assignment or the requirements for your implementation.
NOTE: There is no need to write RDoc (public comments before "class" and public methods) for the tested methods in Card, Deck, and Hand. Why? Because the documentation we hand out is what you must code to. If you ADD public methods, provide RDoc comments for them.
You must specifically address your strategy for evaluating hands. Not doing so will render the 15% portion of the grade devoted to documentation very close to 0.
You must discuss any additional files, classes, or methods that result in additional functionality or convenience for you as the implementer.
It is hard to imagine a readme.txt that is fewer than 350 words. Please make an ordinary text file. No Word, PDF, etc.
What should the readme.txt look like?
Put your name, the course name, and the assignment number at the top of the readme.txt.
The audience of the readme.txt is yourself or another technical staff member such as yourself. The reader knows Ruby and Rails, but may not currently be coding in it. This reader will be responsible for maintaining your code in the future. The reader may be your technical manager. Therefore:
1. Your writeup must be clear.
2. Your writeup must explain where everything is. If you introduce new files, classes, or public methods, say where they are, and what they do, and why they‘re important. A good way convey this kind of information is in the form of a list.
3. If you do anything fancy, you have to explain yourself.
4. The fact that the audience is also yourself is important. Think of what you are doing as a letter to yourself, which you will read in a year long after you‘ve forgotten the code. You will kick yourself if you find your own writing unclear or confusing.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
Do you already have an account? Log in and claim this comment.
I forgot where we should ask questions about assignments, so I put it here. Following AWDR for Mac OS (Leopard), I got Mongrel 1.1.4 instead of 1.1.5. Instruction did not mention update of Mongrel to 1.1.5. Should this be done. I don't know how to downgrade. So, I am trying to be cautious here.
Add New Comment