]> gitweb.factorcode.org Git - factor.git/blobdiff - extra/irc/client/client-docs.factor
factor: trim using lists
[factor.git] / extra / irc / client / client-docs.factor
index aa0bcb3bf319b039c379b0d2860efe7596ee8a0b..698762dc6add432d62e867c655d4e1577b043564 100644 (file)
@@ -1,7 +1,7 @@
 ! Copyright (C) 2009 Bruno Deferrari
 ! See http://factorcode.org/license.txt for BSD license.
-USING: help.markup help.syntax quotations kernel
-irc.messages irc.messages.base irc.messages.parser irc.client.chats ;
+USING: help.markup help.syntax irc.client.chats irc.messages
+irc.messages.base ;
 IN: irc.client
 
 HELP: connect-irc "Connecting to an irc server"
@@ -31,20 +31,24 @@ HELP: hear "Reads a message from a chat"
 ARTICLE: "irc.client" "IRC Client"
 "An IRC Client library"
 { $heading "IRC objects:" }
-{ $subsection irc-client }
+{ $subsections irc-client }
 { $heading "Chat objects:" }
-{ $subsection irc-server-chat }
-{ $subsection irc-channel-chat }
-{ $subsection irc-nick-chat }
+{ $subsections
+    irc-server-chat
+    irc-channel-chat
+    irc-nick-chat
+}
 { $heading "Setup objects:" }
-{ $subsection irc-profile }
+{ $subsections irc-profile }
 { $heading "Words:" }
-{ $subsection connect-irc }
-{ $subsection terminate-irc }
-{ $subsection attach-chat }
-{ $subsection detach-chat }
-{ $subsection hear }
-{ $subsection speak }
+{ $subsections
+    connect-irc
+    terminate-irc
+    attach-chat
+    detach-chat
+    hear
+    speak
+}
 { $heading "IRC messages" }
 "Some of the RFC defined irc messages as objects:"
 { $table
@@ -66,7 +70,7 @@ ARTICLE: "irc.client" "IRC Client"
 { $heading "Special messages" }
 "Some special messages that are created by the library and not by the irc server."
 { $table
-  { { $link irc-chat-end } "sent to a chat when it has been detached from the client, the chat should stop after it receives this message. " }
+  { { $link irc-chat-end } "sent to a chat when it has been detached from the client, the chat should stop after it receives this message." }
   { { $link irc-end } " sent when the client isn't running anymore, the chat should stop after it receives this message." }
   { { $link irc-disconnected } " sent to notify chats that connection was lost." }
   { { $link irc-connected } " sent to notify chats that a connection with the irc server was established." } }
@@ -77,7 +81,7 @@ ARTICLE: "irc.client" "IRC Client"
   "SYMBOL: bot"
   "SYMBOL: mychannel"
   "! Create the profile and client objects"
-  "\"irc.freenode.org\" irc-port \"mybot123\" f <irc-profile> <irc-client> bot set"
+  "\"irc.libera.chat\" irc-port \"mybot123\" f <irc-profile> <irc-client> bot set"
   "! Connect to the server"
   "bot get connect-irc"
   "! Create a channel chat"