From: Eric Wong <kcar-public@bogomips.org>
To: kcar-public@bogomips.org
Subject: [PATCH 2/6] doc: minor updates to describe classes, better
Date: Sun, 5 Mar 2017 23:13:12 +0000 [thread overview]
Message-ID: <20170305231316.8645-3-kcar-public@bogomips.org> (raw)
In-Reply-To: <20170305231316.8645-1-kcar-public@bogomips.org>
---
ext/kcar/kcar.rl | 5 +++++
lib/kcar/response.rb | 4 ++--
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/ext/kcar/kcar.rl b/ext/kcar/kcar.rl
index ef3e393..2155ab4 100644
--- a/ext/kcar/kcar.rl
+++ b/ext/kcar/kcar.rl
@@ -718,6 +718,11 @@ void Init_kcar_ext(void)
VALUE mKcar = rb_define_module("Kcar");
VALUE cParser = rb_define_class_under(mKcar, "Parser", rb_cObject);
+ /*
+ * Document-class: Kcar::ParserError
+ *
+ * This is raised if there are parsing errors.
+ */
eParserError = rb_define_class_under(mKcar, "ParserError", rb_eIOError);
rb_define_alloc_func(cParser, kcar_alloc);
diff --git a/lib/kcar/response.rb b/lib/kcar/response.rb
index 954502c..c74bb4b 100644
--- a/lib/kcar/response.rb
+++ b/lib/kcar/response.rb
@@ -1,8 +1,8 @@
# -*- encoding: binary -*-
-# This may be used to generate a Rack response
-#
+# This may be used to generate a Rack response synchronously.
+
class Kcar::Response
attr_accessor :sock, :hdr, :unchunk, :buf, :parser
--
EW
next prev parent reply other threads:[~2017-03-05 23:13 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-05 23:13 [PATCH 0/6] more minor doc updates Eric Wong
2017-03-05 23:13 ` [PATCH 1/6] update documentation for contributions, remove private address Eric Wong
2017-03-11 21:31 ` [PATCH] HACKING: remove copy+pasted line about N Eric Wong
2017-03-05 23:13 ` Eric Wong [this message]
2017-03-05 23:13 ` [PATCH 3/6] response: remove unnecessary constant alias Eric Wong
2017-03-05 23:13 ` [PATCH 4/6] response: more documentation cleanups Eric Wong
2017-03-05 23:13 ` [PATCH 5/6] favor require_relative to speed up loading Eric Wong
2017-03-05 23:13 ` [PATCH 6/6] response: remove Ruby 1.8-compatibility check Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://yhbt.net/kcar/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170305231316.8645-3-kcar-public@bogomips.org \
--to=kcar-public@bogomips.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhbt.net/kcar.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).