mnbi / textrepo

A repository to store a note text with a timestamp
MIT License
0 stars 0 forks source link

More documenation #12

Closed mnbi closed 4 years ago

mnbi commented 4 years ago

At least, description of API for the following module/class is needed to use textrepo.

mnbi commented 4 years ago

In 0.4.3, some RDoc comments were in wrong format. Because of this issue, those comments are missing in the RI documents.

For example, in FileSystemRepository class, there is a comment looks like:

##
# Deletes the file in the repository.

# :call-seq:
#     delete(Timestamp) => Array

def delete(timestamp)

An empty line before ":call-seq:" is wrong. Just remove the line or replace with an empty comment.

mnbi commented 4 years ago

Following classes should have rdoc comments:

mnbi commented 4 years ago

Checked all documents generated by rdoc. See the check list in the above comment.