Skip to content

Commit caab725

Browse files
author
Jesse Farmer
committed
Add note telling students to delete comments
1 parent 50debfb commit caab725

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,9 @@ To get started, you'll need to
1515
2. `sample_data` is a directory containing sample text files for our text analysis program to analyze
1616
3. `examples/args.rb` is a Ruby program demonstrating how command-line arguments work
1717
4. `examples/file_read.rb` is a Ruby program demonstrating how reading from a file in Ruby works
18+
19+
## Note!
20+
21+
The `textalyze.rb` file that comes with this repository is filled with comments
22+
designed to help you get started. You should feel free to delete them in order to
23+
make the program easier to read.

textalyze.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
# Visit https://github.com/codeunion/text-analysis/wiki to see what to do.
33
#
44
# Send an email to your cohort mailing list if you have any questions
5-
# or you're stuck!
5+
# or you're stuck! These comments are here to help you, but please delete them
6+
# as you go along. You wouldn't normally have such heavily-commented code.
67

78
# Method name: item_counts
89
# Input: An arbitrary array

0 commit comments

Comments
 (0)