doc/index.html in patman-0.0.3 vs doc/index.html in patman-0.0.4
- old
+ new
@@ -1,69 +1,65 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<!DOCTYPE html>
+<html>
<head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: README
- — Documentation by YARD 0.8.7.6
+ — Documentation by YARD 0.9.16
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
- hasFrames = window.top.frames.main ? true : false;
+ pathId = "README";
relpath = '';
- framesUrl = "frames.html#!file.README.html";
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
- <div id="header">
- <div id="menu">
+ <div class="nav_wrap">
+ <iframe id="nav" src="class_list.html?1"></iframe>
+ <div id="resizer"></div>
+ </div>
+
+ <div id="main" tabindex="-1">
+ <div id="header">
+ <div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: README</span>
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
- <div id="search">
+ <div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
- Class List
+
+ <svg width="24" height="24">
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+ </svg>
</a>
- <a class="full_list_link" id="method_list_link"
- href="method_list.html">
- Method List
- </a>
-
- <a class="full_list_link" id="file_list_link"
- href="file_list.html">
- File List
- </a>
-
</div>
- <div class="clear"></div>
- </div>
+ <div class="clear"></div>
+ </div>
- <iframe id="search_frame"></iframe>
-
- <div id="content"><div id='filecontents'>
+ <div id="content"><div id='filecontents'>
<h1 id="label-Patman">Patman</h1>
<p><span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span> (Patch Manipulator) is a library for text file patching. It can
also be used to extract information from files.</p>
@@ -77,11 +73,11 @@
library as content line by line. User finds the place for editing either
with Regexp searches or with direct line numbers. The file content is
edited by adding, removing, or replacing lines. When all edits are done,
the updated file content is written to disk.</p>
-<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Patman</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>edit_me.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span></span><span class='period'>.</span><span class='id identifier rubyid_read'><span class='object_link'><a href="Patman.html#read-class_method" title="Patman.read (method)">read</a></span></span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>edit_me.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span> <span class='int'>10</span>
<span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span>
<span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span>
</code></pre>
@@ -100,11 +96,12 @@
<pre class="code ruby"><code class="ruby">curline = r.line
if curline > 5
r.step -2
else
- r.line 10</code></pre>
+ r.line 10
+</code></pre>
<p>Current line content is returned by “get” and it can be set with “set”
method. Current line content can be replaced with “sub”.</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span> <span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>...</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
@@ -113,11 +110,11 @@
<p><span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span> includes many query commands: line, lines, [], get, find,
get_range, get_for. They all return the queried item. All other methods
return <span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span> object itself, hence many <span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span> methods can be
“chained”.</p>
-<pre class="code ruby"><code class="ruby"><span class='const'>Patman</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>edit_me.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span><span class='lparen'>(</span> <span class='int'>2</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span>
+<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span></span><span class='period'>.</span><span class='id identifier rubyid_read'><span class='object_link'><a href="Patman.html#read-class_method" title="Patman.read (method)">read</a></span></span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>edit_me.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span><span class='lparen'>(</span> <span class='int'>2</span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span>
</code></pre>
<p>Block commands perform commands over a range of lines. Block commands are:
do_all, do_range, and do_for. These retain the original position, but the
final position is stored (actually one after) and it can be activated by
@@ -145,11 +142,11 @@
any editing commands have been applied.</p>
<h2 id="label-Example+session">Example session</h2>
<pre class="code ruby"><code class="ruby"><span class='comment'># Open file for reading.
-</span><span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'>Patman</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>report.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
+</span><span class='id identifier rubyid_r'>r</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Patman.html" title="Patman (class)">Patman</a></span></span><span class='period'>.</span><span class='id identifier rubyid_read'><span class='object_link'><a href="Patman.html#read-class_method" title="Patman.read (method)">read</a></span></span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>report.txt</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span>
<span class='comment'># Backup file and find next line with "error", i.e. method chaining.
</span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_copy'>copy</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>report.txt.org</span><span class='tstring_end'>"</span></span> <span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>error</span><span class='regexp_end'>/</span></span> <span class='rparen'>)</span>
<span class='comment'># Collect some lines.
@@ -168,21 +165,22 @@
<span class='comment'># Save changes.
</span><span class='id identifier rubyid_r'>r</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span>
</code></pre>
-<h2 id="label-Testing+">Testing </h2>
+<h2 id="label-Testing">Testing</h2>
<p>Tests are executed with:</p>
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_rake'>rake</span> <span class='id identifier rubyid_test'>test</span>
</code></pre>
</div></div>
- <div id="footer">
- Generated on Tue Mar 20 20:43:44 2018 by
+ <div id="footer">
+ Generated on Sat Oct 20 17:33:29 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.8.7.6 (ruby-2.3.3).
+ 0.9.16 (ruby-2.5.1).
</div>
+ </div>
</body>
</html>
\ No newline at end of file