Skip to content

Commit 333177c

Browse files
alexvhalexvh
committed
Update docs
1 parent cac4e32 commit 333177c

File tree

45 files changed

+271
-71
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+271
-71
lines changed

‎doc/api-objects.txt‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ gitlab3.GitLab.Project.add_deploy_key gitlab3.GitLab.Project-class.html#add_depl
120120
gitlab3.GitLab.Project.delete_deploy_key gitlab3.GitLab.Project-class.html#delete_deploy_key
121121
gitlab3.GitLab.Project.delete_snippet gitlab3.GitLab.Project-class.html#delete_snippet
122122
gitlab3.GitLab.Project.File gitlab3.GitLab.Project.File-class.html
123+
gitlab3.GitLab.Project.commit gitlab3.GitLab.Project-class.html#commit
123124
gitlab3.GitLab.Project.deploy_key gitlab3.GitLab.Project-class.html#deploy_key
124125
gitlab3.GitLab.Project.Event gitlab3.GitLab.Project.Event-class.html
125126
gitlab3.GitLab.Project.find_milestone gitlab3.GitLab.Project-class.html#find_milestone
@@ -128,6 +129,8 @@ gitlab3.GitLab.Project.Branch gitlab3.GitLab.Project.Branch-class.html
128129
gitlab3.GitLab.Project.Branch.protect gitlab3.GitLab.Project.Branch-class.html#protect
129130
gitlab3.GitLab.Project.Branch.unprotect gitlab3.GitLab.Project.Branch-class.html#unprotect
130131
gitlab3.GitLab.Project.Commit gitlab3.GitLab.Project.Commit-class.html
132+
gitlab3.GitLab.Project.Commit.diff gitlab3.GitLab.Project.Commit-class.html#diff
133+
gitlab3.GitLab.Project.Commit.get_diff gitlab3.GitLab.Project.Commit-class.html#get_diff
131134
gitlab3.GitLab.Project.DeployKey gitlab3.GitLab.Project.DeployKey-class.html
132135
gitlab3.GitLab.Project.DeployKey.delete gitlab3.GitLab.Project.DeployKey-class.html#delete
133136
gitlab3.GitLab.Project.Event gitlab3.GitLab.Project.Event-class.html
@@ -137,10 +140,12 @@ gitlab3.GitLab.Project.Hook.save gitlab3.GitLab.Project.Hook-class.html#save
137140
gitlab3.GitLab.Project.Hook.delete gitlab3.GitLab.Project.Hook-class.html#delete
138141
gitlab3.GitLab.Project.Issue gitlab3.GitLab.Project.Issue-class.html
139142
gitlab3.GitLab.Project.Issue.note gitlab3.GitLab.Project.Issue-class.html#note
143+
gitlab3.GitLab.Project.Issue.reopen gitlab3.GitLab.Project.Issue-class.html#reopen
140144
gitlab3.GitLab.Project.Issue.notes gitlab3.GitLab.Project.Issue-class.html#notes
141145
gitlab3.GitLab.Project.Issue.Note gitlab3.GitLab.Project.Issue.Note-class.html
142146
gitlab3.GitLab.Project.Issue.find_note gitlab3.GitLab.Project.Issue-class.html#find_note
143147
gitlab3.GitLab.Project.Issue.add_note gitlab3.GitLab.Project.Issue-class.html#add_note
148+
gitlab3.GitLab.Project.Issue.close gitlab3.GitLab.Project.Issue-class.html#close
144149
gitlab3.GitLab.Project.Issue.save gitlab3.GitLab.Project.Issue-class.html#save
145150
gitlab3.GitLab.Project.Issue.Note gitlab3.GitLab.Project.Issue.Note-class.html
146151
gitlab3.GitLab.Project.Member gitlab3.GitLab.Project.Member-class.html
@@ -158,9 +163,10 @@ gitlab3.GitLab.Project.MergeRequest.Note gitlab3.GitLab.Project.MergeRequest.Not
158163
gitlab3.GitLab.Project.Milestone gitlab3.GitLab.Project.Milestone-class.html
159164
gitlab3.GitLab.Project.Milestone.save gitlab3.GitLab.Project.Milestone-class.html#save
160165
gitlab3.GitLab.Project.Snippet gitlab3.GitLab.Project.Snippet-class.html
161-
gitlab3.GitLab.Project.Snippet.Note gitlab3.GitLab.Project.Snippet.Note-class.html
162-
gitlab3.GitLab.Project.Snippet.notes gitlab3.GitLab.Project.Snippet-class.html#notes
163166
gitlab3.GitLab.Project.Snippet.get_raw gitlab3.GitLab.Project.Snippet-class.html#get_raw
167+
gitlab3.GitLab.Project.Snippet.raw gitlab3.GitLab.Project.Snippet-class.html#raw
168+
gitlab3.GitLab.Project.Snippet.notes gitlab3.GitLab.Project.Snippet-class.html#notes
169+
gitlab3.GitLab.Project.Snippet.Note gitlab3.GitLab.Project.Snippet.Note-class.html
164170
gitlab3.GitLab.Project.Snippet.note gitlab3.GitLab.Project.Snippet-class.html#note
165171
gitlab3.GitLab.Project.Snippet.find_note gitlab3.GitLab.Project.Snippet-class.html#find_note
166172
gitlab3.GitLab.Project.Snippet.add_note gitlab3.GitLab.Project.Snippet-class.html#add_note

‎doc/class-tree.html‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,18 +87,18 @@ <h1 class="epydoc">Class Hierarchy</h1>
8787
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Hook-class.html">gitlab3.GitLab.Project.Hook</a></strong>:
8888
<em class="summary">A project hook.</em>
8989
</li>
90-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue-class.html">gitlab3.GitLab.Project.Issue</a></strong>:
91-
<em class="summary">A project issue.</em>
92-
</li>
9390
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Issue-class.html">gitlab3.GitLab.Issue</a></strong>:
9491
<em class="summary">An issue.</em>
9592
</li>
96-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Member-class.html">gitlab3.GitLab.Project.Member</a></strong>:
97-
<em class="summary">A project member.</em>
93+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue-class.html">gitlab3.GitLab.Project.Issue</a></strong>:
94+
<em class="summary">A project issue.</em>
9895
</li>
9996
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Team.Member-class.html">gitlab3.GitLab.Team.Member</a></strong>:
10097
<em class="summary">A member in a team.</em>
10198
</li>
99+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Member-class.html">gitlab3.GitLab.Project.Member</a></strong>:
100+
<em class="summary">A project member.</em>
101+
</li>
102102
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.MergeRequest-class.html">gitlab3.GitLab.Project.MergeRequest</a></strong>:
103103
<em class="summary">A merge request.</em>
104104
</li>
@@ -108,12 +108,12 @@ <h1 class="epydoc">Class Hierarchy</h1>
108108
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.MergeRequest.Note-class.html">gitlab3.GitLab.Project.MergeRequest.Note</a></strong>:
109109
<em class="summary">A merge request note.</em>
110110
</li>
111-
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue.Note-class.html">gitlab3.GitLab.Project.Issue.Note</a></strong>:
112-
<em class="summary">An issue note.</em>
113-
</li>
114111
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Snippet.Note-class.html">gitlab3.GitLab.Project.Snippet.Note</a></strong>:
115112
<em class="summary">A snippet note.</em>
116113
</li>
114+
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project.Issue.Note-class.html">gitlab3.GitLab.Project.Issue.Note</a></strong>:
115+
<em class="summary">An issue note.</em>
116+
</li>
117117
<li> <strong class="uidlink"><a href="gitlab3.GitLab.Project-class.html">gitlab3.GitLab.Project</a></strong>:
118118
<em class="summary">A project.</em>
119119
</li>
@@ -223,7 +223,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
223223
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
224224
<tr>
225225
<td align="left" class="footer">
226-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
226+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
227227
</td>
228228
<td align="right" class="footer">
229229
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3-module.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h1 class="epydoc">Package gitlab3</h1><p class="nomargin-top"></p>
142142
<td width="15%" align="right" valign="top" class="summary">
143143
<span class="summary-type">&nbsp;</span>
144144
</td><td class="summary">
145-
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code>
145+
<a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'gitlab3'"><code class="variable-quote">'</code><code class="variable-string">gitlab3</code><code class="variable-quote">'</code></code>
146146
</td>
147147
</tr>
148148
</table>
@@ -177,7 +177,7 @@ <h1 class="epydoc">Package gitlab3</h1><p class="nomargin-top"></p>
177177
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
178178
<tr>
179179
<td align="left" class="footer">
180-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
180+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
181181
</td>
182182
<td align="right" class="footer">
183183
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1324,7 +1324,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">login</span>(<span c
13241324
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
13251325
<tr>
13261326
<td align="left" class="footer">
1327-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
1327+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
13281328
</td>
13291329
<td align="right" class="footer">
13301330
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.CurrentUser-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">add_ssh_key</span>(<
345345
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
346346
<tr>
347347
<td align="left" class="footer">
348-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
348+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
349349
</td>
350350
<td align="right" class="footer">
351351
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.CurrentUser.SSHKey-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ <h1 class="epydoc">Class SSHKey</h1><p class="nomargin-top"></p>
134134
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
135135
<tr>
136136
<td align="left" class="footer">
137-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
137+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
138138
</td>
139139
<td align="right" class="footer">
140140
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.Group-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ <h1 class="epydoc">Class Group</h1><p class="nomargin-top"></p>
132132
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
133133
<tr>
134134
<td align="left" class="footer">
135-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
135+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
136136
</td>
137137
<td align="right" class="footer">
138138
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.Issue-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ <h1 class="epydoc">Class Issue</h1><p class="nomargin-top"></p>
9797
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
9898
<tr>
9999
<td align="left" class="footer">
100-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
100+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
101101
</td>
102102
<td align="right" class="footer">
103103
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.Project-class.html‎

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1196,6 +1196,23 @@ <h1 class="epydoc">Class Project</h1><p class="nomargin-top"></p>
11961196
<td align="right" valign="top">
11971197

11981198

1199+
</td>
1200+
</tr>
1201+
</table>
1202+
1203+
</td>
1204+
</tr>
1205+
<tr>
1206+
<td width="15%" align="right" valign="top" class="summary">
1207+
<span class="summary-type">&nbsp;</span>
1208+
</td><td class="summary">
1209+
<table width="100%" cellpadding="0" cellspacing="0" border="0">
1210+
<tr>
1211+
<td><span class="summary-sig"><a href="gitlab3.GitLab.Project-class.html#commit" class="summary-sig-name">commit</a>(<span class="summary-sig-arg">id</span>)</span><br />
1212+
Return the Commit specified by the given <i>id</i>.</td>
1213+
<td align="right" valign="top">
1214+
1215+
11991216
</td>
12001217
</tr>
12011218
</table>
@@ -2296,6 +2313,26 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">find_commit</span>(<
22962313
</dl>
22972314
</td></tr></table>
22982315
</div>
2316+
<a name="commit"></a>
2317+
<div>
2318+
<table class="details" border="1" cellpadding="3"
2319+
cellspacing="0" width="100%" bgcolor="white">
2320+
<tr><td>
2321+
<table width="100%" cellpadding="0" cellspacing="0" border="0">
2322+
<tr valign="top"><td>
2323+
<h3 class="epydoc"><span class="sig"><span class="sig-name">commit</span>(<span class="sig-arg">id</span>)</span>
2324+
</h3>
2325+
</td><td align="right" valign="top"
2326+
>&nbsp;
2327+
</td>
2328+
</tr></table>
2329+
2330+
<p>Return the Commit specified by the given <i>id</i>.
2331+
<i>get_commit()</i> may be used as an alias for this function.</p>
2332+
<dl class="fields">
2333+
</dl>
2334+
</td></tr></table>
2335+
</div>
22992336
<a name="wall_notes"></a>
23002337
<div>
23012338
<table class="details" border="1" cellpadding="3"
@@ -2420,7 +2457,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">add_wall_note</span>
24202457
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
24212458
<tr>
24222459
<td align="left" class="footer">
2423-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
2460+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
24242461
</td>
24252462
<td align="right" class="footer">
24262463
<a target="mainFrame" href="http://epydoc.sourceforge.net"

‎doc/gitlab3.GitLab.Project.Branch-class.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">unprotect</span>()</
210210
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
211211
<tr>
212212
<td align="left" class="footer">
213-
Generated by Epydoc 3.0.1 on Mon Aug 26 22:22:12 2013
213+
Generated by Epydoc 3.0.1 on Wed Aug 28 20:56:41 2013
214214
</td>
215215
<td align="right" class="footer">
216216
<a target="mainFrame" href="http://epydoc.sourceforge.net"

0 commit comments

Comments
 (0)