Skip to content

Commit 706b898

Browse files
Chris HooksChris Hooks
authored andcommitted
Changed :mod: to :class: in docstrings
1 parent 89c2af2 commit 706b898

File tree

6 files changed

+25
-25
lines changed

6 files changed

+25
-25
lines changed

tincan/agent.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ def account(self):
156156
"""Account for Agent
157157
158158
:setter: Tries to convert to Account
159-
:setter type: :mod:`tincan.agent_account`
160-
:rtype: :mod:`tincan.agent_account`
159+
:setter type: :class:`tincan.agent_account.AgentAccount`
160+
:rtype: :class:`tincan.agent_account.AgentAccount`
161161
162162
"""
163163
return self._account

tincan/attachment.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,8 @@ def display(self):
161161
"""Display for Attachment
162162
163163
:setter: Tries to convert to LanguageMap
164-
:setter type: :mod:`tincan.language_map`
165-
:rtype: :mod:`tincan.language_map`
164+
:setter type: :class:`tincan.language_map.LanguageMap`
165+
:rtype: :class:`tincan.language_map.LanguageMap`
166166
167167
"""
168168
return self._display
@@ -182,8 +182,8 @@ def description(self):
182182
"""Description for Attachment
183183
184184
:setter: Tries to convert to LanguageMap
185-
:setter type: :mod:`tincan.language_map`
186-
:rtype: :mod:`tincan.language_map`
185+
:setter type: :class:`tincan.language_map.LanguageMap`
186+
:rtype: :class:`tincan.language_map.LanguageMap`
187187
188188
"""
189189
return self._description

tincan/group.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def addmember(self, value):
4343
"""Adds a single member to this group's list of members
4444
4545
:param value: The member to add to this group
46-
:type value: :mod:`tincan.agent`
46+
:type value: :class:`tincan.agent.Agent`
4747
4848
"""
4949

@@ -57,8 +57,8 @@ def member(self):
5757
"""Members for Group
5858
5959
:setter: Tries to convert to AgentList
60-
:setter type: :mod:`tincan.agent_list`
61-
:rtype: :mod:`tincan.agent_list`
60+
:setter type: :class:`tincan.agent_list.AgentList`
61+
:rtype: :class:`tincan.agent_list.AgentList`
6262
"""
6363
return self._member
6464

tincan/statement.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ def object(self):
8787
"""Object for Statement
8888
8989
:setter: Sets the object
90-
:setter type: :mod:`tincan.agent` | :mod:`tincan.group` | :mod:`tincan.statement_ref` | :mod:`tincan.substatement` | :mod:`tincan.activity`
91-
:rtype: :mod:`tincan.agent` | :mod:`tincan.group` | :mod:`tincan.statement_ref` | :mod:`tincan.substatement` | :mod:`tincan.activity`
90+
:setter type: :class:`tincan.agent.Agent` | :class:`tincan.group.Group` | :class:`tincan.statement_ref.StatementRef` | :class:`tincan.substatement.SubStatement` | :class:`tincan.activity.Activity`
91+
:rtype: :class:`tincan.agent.Agent` | :class:`tincan.group.Group` | :class:`tincan.statement_ref.StatementRef` | :class:`tincan.substatement.SubStatement` | :class:`tincan.activity.Activity`
9292
9393
"""
9494
return self._object
@@ -173,8 +173,8 @@ def authority(self):
173173
"""Authority for Statement
174174
175175
:setter: Tries to convert to Agent
176-
:setter type: :mod:`tincan.agent`
177-
:rtype: :mod:`tincan.agent`
176+
:setter type: :class:`tincan.agent.Agent`
177+
:rtype: :class:`tincan.agent.Agent`
178178
179179
"""
180180
return self._authority
@@ -194,8 +194,8 @@ def result(self):
194194
"""Result for Statement
195195
196196
:setter: Tries to convert to Result
197-
:setter type: :mod:`tincan.result`
198-
:rtype: :mod:`tincan.result`
197+
:setter type: :class:`tincan.result.Result`
198+
:rtype: :class:`tincan.result.Result`
199199
200200
"""
201201
return self._result

tincan/statement_base.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ def actor(self):
5050
"""Actor for StatementBase
5151
5252
:setter: Tries to convert to Agent or Group
53-
:setter type: :mod:`tincan.agent` | :mod:`tincan.group`
54-
:rtype: :mod:`tincan.agent` | :mod:`tincan.group`
53+
:setter type: :class:`tincan.agent.Agent` | :class:`tincan.group.Group`
54+
:rtype: :class:`tincan.agent.Agent` | :class:`tincan.group.Group`
5555
5656
"""
5757
return self._actor
@@ -83,8 +83,8 @@ def verb(self):
8383
"""Verb for StatementBase
8484
8585
:setter: Tries to convert to Verb
86-
:setter type: :mod:`tincan.verb`
87-
:rtype: :mod:`tincan.verb`
86+
:setter type: :class:`tincan.verb.Verb`
87+
:rtype: :class:`tincan.verb.Verb`
8888
8989
"""
9090
return self._verb
@@ -152,8 +152,8 @@ def context(self):
152152
"""Context for StatementBase
153153
154154
:setter: Tries to convert to Context
155-
:setter type: :mod:`tincan.context`
156-
:rtype: :mod:`tincan.context`
155+
:setter type: :class:`tincan.context.Context`
156+
:rtype: :class:`tincan.context.Context`
157157
158158
"""
159159
return self._context
@@ -173,8 +173,8 @@ def attachments(self):
173173
"""Attachments for StatementBase
174174
175175
:setter: Tries to convert each element to Attachment
176-
:setter type: :mod:`tincan.attachment_list`
177-
:rtype: :mod:`tincan.attachment_list`
176+
:setter type: :class:`tincan.attachment_list.AttachmentList`
177+
:rtype: :class:`tincan.attachment_list.AttachmentList`
178178
179179
"""
180180
return self._attachments

tincan/substatement.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ def object(self):
3636
"""Object for SubStatement
3737
3838
:setter: Setter for object
39-
:setter type: :mod:`tincan.Agent` | :mod:`tincan.Group`
40-
:rtype: :mod:`tincan.agent` | :mod:`tincan.group` | :mod:`tincan.activity`
39+
:setter type: :class:`tincan.agent.Agent` | :class:`tincan.group.Group` | :class:`tincan.activity.Activity`
40+
:rtype: :class:`tincan.agent.Agent` | :class:`tincan.group.Group` | :class:`tincan.activity.Activity`
4141
4242
"""
4343
return self._object

0 commit comments

Comments
 (0)