From: Eric Wong <e@80x24.org>
To: olddoc-public@80x24.org
Subject: [PATCH 3/3] readme: relax dependency on RDoc formatting
Date: Thu, 15 Oct 2015 01:04:53 +0000 [thread overview]
Message-ID: <20151015010453.24454-4-e@80x24.org> (raw)
In-Reply-To: <20151015010453.24454-1-e@80x24.org>
Some projects I maintain do not use RDoc and rely entirely on
plain-text documentation. This allows "olddoc prepare" to
run properly on projects which do not use RDoc but still use
a README file where the title is the first line.
---
lib/olddoc/readme.rb | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/olddoc/readme.rb b/lib/olddoc/readme.rb
index 18f0205..e593517 100644
--- a/lib/olddoc/readme.rb
+++ b/lib/olddoc/readme.rb
@@ -16,9 +16,9 @@ def readme_description
# parses the README file in the top-level directory for project metadata
def readme_metadata
l = File.readlines(readme_path)[0].strip!
- l.gsub!(/^=\s+/, '') or abort "#{l.inspect} doesn't start with '='"
+ l.gsub!(/^=\s+/, '')
title = l.dup
- if l.gsub!(/^(\w+\!)\s+/, '') # Rainbows!
+ if l.gsub!(/^(\w+\!)\s+/, '') # special case for Rainbows!
return $1, l, title
else
return (l.split(/\s*[:-]\s*/, 2)).push(title)
--
EW
prev parent reply other threads:[~2015-10-15 1:04 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-10-15 1:04 [PATCH 0/3] minor updates in preparation for olddoc 1.1.0 Eric Wong
2015-10-15 1:04 ` [PATCH 1/3] support for nntp_url, make private_email optional Eric Wong
2015-10-15 1:04 ` [PATCH 2/3] gemspec: use SPDX-compatible license Eric Wong
2015-10-15 1:04 ` Eric Wong [this message]
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://80x24.org/olddoc/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20151015010453.24454-4-e@80x24.org \
--to=e@80x24.org \
--cc=olddoc-public@80x24.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://80x24.org/olddoc.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).