Skip to content

Commit 54a2304

Browse files
committed
docs fixes and forgotten updates
1 parent d98864b commit 54a2304

8 files changed

Lines changed: 27 additions & 12 deletions

File tree

CHANGELOG.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Changelog
6464
of being converted to ``ResourceSet`` object
6565
- Downloads were downloaded fully into memory instead of being streamed as needed
6666
- ``ResourceRequirementsError`` exception was broken since v2.0.0
67+
- RedmineUP CRM Contact and Deal resources export functionality didn't work
6768
- RedmineUP CRM Contact and Deal resources sometimes weren't converted to Resource objects using Search API
6869

6970
**Documentation**:

docs/editions.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,19 @@ between these editions:
207207
<td class="not-implemented">NO</td>
208208
<td class="implemented">YES</td>
209209
</tr>
210+
<tr>
211+
<td class="group" colspan="3">Lookups</td>
212+
</tr>
213+
<tr>
214+
<td class="feature">Exact</td>
215+
<td class="implemented">YES</td>
216+
<td class="implemented">YES</td>
217+
</tr>
218+
<tr>
219+
<td class="feature">In</td>
220+
<td class="implemented">YES</td>
221+
<td class="implemented">YES</td>
222+
</tr>
210223
<tr>
211224
<td class="group" colspan="3">Advanced features</td>
212225
</tr>

docs/resources/attachment.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ delete
141141

142142
Deletes single Attachment resource from Redmine by it's id.
143143

144-
:param int resource_id: (required). Version id.
144+
:param int resource_id: (required). Attachment id.
145145
:return: True
146146

147147
.. code-block:: python
@@ -166,4 +166,4 @@ delete
166166
Export
167167
------
168168

169-
Not supported by Redmine
169+
Export functionality doesn't make sense for attachments as they can be downloaded

docs/resources/file.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ filter
144144

145145
:param project_id: (optional). Get files from the project with given id.
146146
:type project_id: int or string
147-
:return: ResourceSet object
147+
:return: :ref:`ResourceSet` object
148148

149149
.. code-block:: python
150150

docs/resources/project.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,7 @@ get
141141
* issue_categories
142142
* versions
143143
* news
144+
* files
144145
* issues
145146
* time_entries
146147
* deals (requires Pro Edition and `CRM plugin <https://www.redmineup.com/pages/plugins/crm>`_)

docs/resources/project_membership.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ new
4343

4444
Creates new empty ProjectMembership resource but saves it to the Redmine only when ``save()`` is
4545
called, also calls ``pre_create()`` and ``post_create()`` methods of the :ref:`Resource` object.
46-
Valid attributes are the same as for ``create()`` method above.bove.
46+
Valid attributes are the same as for ``create()`` method above.
4747

4848
:return: :ref:`Resource` object
4949

docs/resources/time_entry.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ new
5454

5555
Creates new empty TimeEntry resource but saves it to the Redmine only when ``save()`` is called, also
5656
calls ``pre_create()`` and ``post_create()`` methods of the :ref:`Resource` object. Valid attributes
57-
are the same as for ``create()`` method above.bove.
57+
are the same as for ``create()`` method above.
5858

5959
:return: :ref:`Resource` object
6060

@@ -131,7 +131,7 @@ filter
131131
:param string hours: (optional). Get only time entries that are =, >=, <= hours.
132132
:param int limit: (optional). How much resources to return.
133133
:param int offset: (optional). Starting from what resource to return the other resources.
134-
:return: ResourceSet object
134+
:return: :ref:`ResourceSet` object
135135

136136
.. code-block:: python
137137

docs/resources/wiki_page.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ create
1717
++++++
1818

1919
.. py:method:: create(**fields)
20-
:module: redminelib.managers.ResourceManager
20+
:module: redminelib.managers.WikiPageManager
2121
:noindex:
2222

2323
Creates new WikiPage resource with given fields and saves it to the Redmine.
@@ -58,7 +58,7 @@ new
5858
+++
5959

6060
.. py:method:: new()
61-
:module: redminelib.managers.ResourceManager
61+
:module: redminelib.managers.WikiPageManager
6262
:noindex:
6363

6464
Creates new empty WikiPage resource but saves it to the Redmine only when ``save()`` is called, also
@@ -86,7 +86,7 @@ get
8686
+++
8787

8888
.. py:method:: get(resource_id, **params)
89-
:module: redminelib.managers.ResourceManager
89+
:module: redminelib.managers.WikiPageManager
9090
:noindex:
9191

9292
Returns single WikiPage resource from Redmine by it's title.
@@ -134,7 +134,7 @@ filter
134134
++++++
135135

136136
.. py:method:: filter(**filters)
137-
:module: redminelib.managers.ResourceManager
137+
:module: redminelib.managers.WikiPageManager
138138
:noindex:
139139

140140
Returns WikiPage resources that match the given lookup parameters.
@@ -168,7 +168,7 @@ update
168168
++++++
169169

170170
.. py:method:: update(resource_id, **fields)
171-
:module: redminelib.managers.ResourceManager
171+
:module: redminelib.managers.WikiPageManager
172172
:noindex:
173173

174174
Updates values of given fields of a WikiPage resource and saves them to the Redmine.
@@ -250,7 +250,7 @@ delete
250250
++++++
251251

252252
.. py:method:: delete(resource_id, **params)
253-
:module: redminelib.managers.ResourceManager
253+
:module: redminelib.managers.WikiPageManager
254254
:noindex:
255255

256256
Deletes single WikiPage resource from Redmine by it's title.

0 commit comments

Comments
 (0)