Browse files

Consistent documentation is good documentation.

  • Loading branch information...
1 parent 59c7114 commit adb6fc773a66eaaea0e3766eeeac2f0d0c9aea28 @wilkie wilkie committed May 20, 2011
Showing with 3 additions and 4 deletions.
  1. +3 −4 lib/ostatus/salmon.rb
View
7 lib/ostatus/salmon.rb
@@ -14,7 +14,7 @@ def initialize entry, signature = nil, plaintext = nil
@plaintext = plaintext
end
- # Creates an entry for following a particular Author
+ # Creates an entry for following a particular Author.
def Salmon.from_follow(user_author, followed_author)
entry = OStatus::Entry.new(
:author => user_author,
@@ -28,7 +28,7 @@ def Salmon.from_follow(user_author, followed_author)
OStatus::Salmon.new(entry)
end
- # Creates an entry for unfollowing a particular Author
+ # Creates an entry for unfollowing a particular Author.
def Salmon.from_unfollow(user_author, followed_author)
entry = OStatus::Entry.new(
:author => user_author,
@@ -42,8 +42,7 @@ def Salmon.from_unfollow(user_author, followed_author)
OStatus::Salmon.new(entry)
end
- # Generate a magic envelope from an OStatus::Entry or pull an
- # OStatus::Entry from a magic envelope
+ # Will pull a OStatus::Entry from a magic envelope described by the xml.
def Salmon.from_xml source
if source.is_a?(String)
source = XML::Document.string(source,

0 comments on commit adb6fc7

Please sign in to comment.