Skip to content

Commit

Permalink
📖 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
elifoster committed Jun 21, 2017
1 parent c539c99 commit fc6e045
Show file tree
Hide file tree
Showing 59 changed files with 5,424 additions and 8,145 deletions.
1 change: 1 addition & 0 deletions .yardopts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
--private
--protected
--markup=markdown
--output-dir ./docs/
-
CHANGELOG.md
LICENSE.md
78 changes: 39 additions & 39 deletions docs/MediaWiki.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!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>
Module: MediaWiki

&mdash; Documentation by YARD 0.8.7.6
&mdash; Documentation by YARD 0.9.9

</title>

Expand All @@ -15,9 +15,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 = "MediaWiki";
relpath = '';
framesUrl = "frames.html#!MediaWiki.html";
</script>


Expand All @@ -28,63 +27,63 @@

</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 (M)</a> &raquo;


<span class="title">MediaWiki</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
</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

<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>

</div>
<div class="clear"></div>
</div>
<div class="clear"></div>
</div>

<iframe id="search_frame"></iframe>

<div id="content"><h1>Module: MediaWiki
<div id="content"><h1>Module: MediaWiki



</h1>
<div class="box_info">


<dl class="box">









<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/mediawiki/auth.rb<span class="defines">,<br />
lib/mediawiki/butt.rb,<br /> lib/mediawiki/edit.rb,<br /> lib/mediawiki/watch.rb,<br /> lib/mediawiki/utils.rb,<br /> lib/mediawiki/purge.rb,<br /> lib/mediawiki/constants.rb,<br /> lib/mediawiki/exceptions.rb,<br /> lib/mediawiki/query/query.rb,<br /> lib/mediawiki/administration.rb,<br /> lib/mediawiki/query/lists/all.rb,<br /> lib/mediawiki/query/meta/meta.rb,<br /> lib/mediawiki/query/lists/users.rb,<br /> lib/mediawiki/query/lists/lists.rb,<br /> lib/mediawiki/query/lists/search.rb,<br /> lib/mediawiki/query/lists/log/log.rb,<br /> lib/mediawiki/query/meta/userinfo.rb,<br /> lib/mediawiki/query/meta/siteinfo.rb,<br /> lib/mediawiki/query/lists/log/move.rb,<br /> lib/mediawiki/query/lists/log/merge.rb,<br /> lib/mediawiki/query/lists/backlinks.rb,<br /> lib/mediawiki/query/lists/log/block.rb,<br /> lib/mediawiki/query/lists/querypage.rb,<br /> lib/mediawiki/query/lists/log/delete.rb,<br /> lib/mediawiki/query/lists/log/patrol.rb,<br /> lib/mediawiki/query/lists/log/rights.rb,<br /> lib/mediawiki/query/lists/log/upload.rb,<br /> lib/mediawiki/query/properties/files.rb,<br /> lib/mediawiki/query/properties/pages.rb,<br /> lib/mediawiki/query/lists/log/import.rb,<br /> lib/mediawiki/query/lists/categories.rb,<br /> lib/mediawiki/query/meta/filerepoinfo.rb,<br /> lib/mediawiki/query/lists/log/protect.rb,<br /> lib/mediawiki/query/lists/log/newusers.rb,<br /> lib/mediawiki/query/lists/miscellaneous.rb,<br /> lib/mediawiki/query/lists/recent_changes.rb,<br /> lib/mediawiki/query/properties/properties.rb,<br /> lib/mediawiki/query/properties/contributors.rb</span>


<dl>
<dt>Defined in:</dt>
<dd>lib/mediawiki/auth.rb<span class="defines">,<br />
lib/mediawiki/butt.rb,<br /> lib/mediawiki/edit.rb,<br /> lib/mediawiki/purge.rb,<br /> lib/mediawiki/utils.rb,<br /> lib/mediawiki/watch.rb,<br /> lib/mediawiki/constants.rb,<br /> lib/mediawiki/exceptions.rb,<br /> lib/mediawiki/query/query.rb,<br /> lib/mediawiki/administration.rb,<br /> lib/mediawiki/query/lists/all.rb,<br /> lib/mediawiki/query/meta/meta.rb,<br /> lib/mediawiki/query/lists/lists.rb,<br /> lib/mediawiki/query/lists/users.rb,<br /> lib/mediawiki/query/lists/search.rb,<br /> lib/mediawiki/query/lists/log/log.rb,<br /> lib/mediawiki/query/meta/siteinfo.rb,<br /> lib/mediawiki/query/meta/userinfo.rb,<br /> lib/mediawiki/query/lists/log/move.rb,<br /> lib/mediawiki/query/lists/backlinks.rb,<br /> lib/mediawiki/query/lists/log/block.rb,<br /> lib/mediawiki/query/lists/log/merge.rb,<br /> lib/mediawiki/query/lists/querypage.rb,<br /> lib/mediawiki/query/lists/categories.rb,<br /> lib/mediawiki/query/lists/log/delete.rb,<br /> lib/mediawiki/query/lists/log/import.rb,<br /> lib/mediawiki/query/lists/log/patrol.rb,<br /> lib/mediawiki/query/lists/log/rights.rb,<br /> lib/mediawiki/query/lists/log/upload.rb,<br /> lib/mediawiki/query/properties/files.rb,<br /> lib/mediawiki/query/properties/pages.rb,<br /> lib/mediawiki/query/lists/log/protect.rb,<br /> lib/mediawiki/query/meta/filerepoinfo.rb,<br /> lib/mediawiki/query/lists/log/newusers.rb,<br /> lib/mediawiki/query/lists/miscellaneous.rb,<br /> lib/mediawiki/query/lists/recent_changes.rb,<br /> lib/mediawiki/query/properties/properties.rb,<br /> lib/mediawiki/query/properties/contributors.rb</span>
</dd>
</dl>

</dl>
<div class="clear"></div>
</div>

<h2>Defined Under Namespace</h2>
<p class="children">
Expand All @@ -109,11 +108,12 @@ <h2>Defined Under Namespace</h2>

</div>

<div id="footer">
Generated on Wed Oct 19 09:55:10 2016 by
<div id="footer">
Generated on Tue Jun 20 19:54:22 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
0.9.9 (ruby-2.4.1).
</div>

</div>
</body>
</html>
97 changes: 49 additions & 48 deletions docs/MediaWiki/Administration.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!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>
Module: MediaWiki::Administration

&mdash; Documentation by YARD 0.8.7.6
&mdash; Documentation by YARD 0.9.9

</title>

Expand All @@ -15,9 +15,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 = "MediaWiki::Administration";
relpath = '../';
framesUrl = "../frames.html#!MediaWiki/Administration.html";
</script>


Expand All @@ -28,65 +27,66 @@

</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)</a> &raquo;
<span class='title'><span class='object_link'><a href="../MediaWiki.html" title="MediaWiki (module)">MediaWiki</a></span></span>
&raquo;
<span class="title">Administration</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
</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

<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>

</div>
<div class="clear"></div>
</div>

<iframe id="search_frame"></iframe>
<div class="clear"></div>
</div>

<div id="content"><h1>Module: MediaWiki::Administration
<div id="content"><h1>Module: MediaWiki::Administration



</h1>
<div class="box_info">


<dl class="box">







<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="Butt.html" title="MediaWiki::Butt (class)">Butt</a></span></dd>



<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="Butt.html" title="MediaWiki::Butt (class)">Butt</a></span></dd>
</dl>

<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/mediawiki/administration.rb</dd>


<dl>
<dt>Defined in:</dt>
<dd>lib/mediawiki/administration.rb</dd>
</dl>

</dl>
<div class="clear"></div>
</div>



Expand All @@ -98,15 +98,15 @@

<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>

<ul class="summary">

<li class="public ">
<span class="summary_signature">

<a href="#block-instance_method" title="#block (instance method)">- (Fixnum) <strong>block</strong>(user, expiry = &#39;2 weeks&#39;, reason = nil, nocreate = true) </a>
<a href="#block-instance_method" title="#block (instance method)">#<strong>block</strong>(user, expiry = &#39;2 weeks&#39;, reason = nil, nocreate = true) &#x21d2; Fixnum </a>



Expand All @@ -129,7 +129,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#unblock-instance_method" title="#unblock (instance method)">- (Fixnum) <strong>unblock</strong>(user, reason = nil) </a>
<a href="#unblock-instance_method" title="#unblock (instance method)">#<strong>unblock</strong>(user, reason = nil) &#x21d2; Fixnum </a>



Expand Down Expand Up @@ -161,7 +161,7 @@ <h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="block-instance_method">

- (<tt>Fixnum</tt>) <strong>block</strong>(user, expiry = &#39;2 weeks&#39;, reason = nil, nocreate = true)
#<strong>block</strong>(user, expiry = &#39;2 weeks&#39;, reason = nil, nocreate = true) &#x21d2; <tt>Fixnum</tt>



Expand Down Expand Up @@ -344,7 +344,7 @@ <h3 class="signature first" id="block-instance_method">
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>

<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>MediaWiki</span><span class='op'>::</span><span class='const'>Butt</span><span class='op'>::</span><span class='const'>BlockError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown error code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../MediaWiki.html" title="MediaWiki (module)">MediaWiki</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Butt.html" title="MediaWiki::Butt (class)">Butt</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Butt/BlockError.html" title="MediaWiki::Butt::BlockError (class)">BlockError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Butt.html#initialize-instance_method" title="MediaWiki::Butt#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown error code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
Expand All @@ -357,7 +357,7 @@ <h3 class="signature first" id="block-instance_method">
<div class="method_details ">
<h3 class="signature " id="unblock-instance_method">

- (<tt>Fixnum</tt>) <strong>unblock</strong>(user, reason = nil)
#<strong>unblock</strong>(user, reason = nil) &#x21d2; <tt>Fixnum</tt>



Expand Down Expand Up @@ -500,7 +500,7 @@ <h3 class="signature " id="unblock-instance_method">
<span class='id identifier rubyid_response'>response</span> <span class='op'>=</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>

<span class='kw'>if</span> <span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>MediaWiki</span><span class='op'>::</span><span class='const'>Butt</span><span class='op'>::</span><span class='const'>BlockError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown error code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../MediaWiki.html" title="MediaWiki (module)">MediaWiki</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Butt.html" title="MediaWiki::Butt (class)">Butt</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Butt/BlockError.html" title="MediaWiki::Butt::BlockError (class)">BlockError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Butt.html#initialize-instance_method" title="MediaWiki::Butt#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_dig'>dig</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>error</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='op'>||</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Unknown error code</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_response'>response</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span>
Expand All @@ -514,11 +514,12 @@ <h3 class="signature " id="unblock-instance_method">

</div>

<div id="footer">
Generated on Wed Oct 19 09:55:10 2016 by
<div id="footer">
Generated on Tue Jun 20 19:54:23 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
0.9.9 (ruby-2.4.1).
</div>

</div>
</body>
</html>
Loading

0 comments on commit fc6e045

Please sign in to comment.