Skip to content

Commit dee4bef

Browse files
authored
Merge pull request #141 from olafmeneses/fix-documentation-typos
Fix minor typos in documentation
2 parents 01d0936 + d90fb59 commit dee4bef

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

docs/agents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ As you know, messages are the basis of every MAS. They are the centre of the who
7575
in which MAS are based. So it is very important to understand which facilities are present in SPADE to work with
7676
agent messages.
7777

78-
First and foremost, threre is a ``Message`` class. This class is ``spade.message.Message`` and you can instantiate it to
78+
First and foremost, there is a ``Message`` class. This class is ``spade.message.Message`` and you can instantiate it to
7979
create new messages to work with. The class provides a method to introduce metadata into messages, this is useful for
8080
using the fields present in standard FIPA-ACL Messages. When a message is ready to be sent, it can be passed on to the
8181
send() method of the behaviour, which will trigger the internal communication process to actually send it to its

docs/behaviours.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ and, of course, use the ``send`` and ``receive`` coroutines to be able to intera
235235

236236
Transitions in a ``FSMBehaviour`` define from which state to which state it is allowed to transit. A ``State`` defines
237237
its transit to another state by using the ``set_next_state`` method in its ``run`` coroutine.
238-
By using the ``set_next_state`` method a state dinamically expresses to which state it transits when it finishes. After
238+
By using the ``set_next_state`` method a state dynamically expresses to which state it transits when it finishes. After
239239
running a state, the FSM reads this *next_state* value and, if the transition is valid, it transits to that state.
240240

241241
.. warning:: If the transition is not registered it raises a ``NotValidTransition`` exception and the FSM behaviour is
@@ -291,7 +291,7 @@ transit to::
291291
print("I'm at state three (final state)")
292292
msg = await self.receive(timeout=5)
293293
print(f"State Three received message {msg.body}")
294-
# no final state is setted, since this is a final state
294+
# no final state is set, since this is a final state
295295

296296

297297
class FSMAgent(Agent):

docs/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,8 @@ the following output
125125
And that's it! We have built our first SPADE Agent in 6 lines of code. Easy, isn't it? Of course, this is a very very
126126
dumb agent that does nothing, but it serves well as a starting point to understand the logics behind SPADE.
127127

128-
.. note:: A SPADE agent is an asyncronous agent. That means that all the code to run an agent must be executed in an
129-
asyncronous loop. This is done by the ``spade.run()`` function. This function receives a coroutine as a parameter
128+
.. note:: A SPADE agent is an asynchronous agent. That means that all the code to run an agent must be executed in an
129+
asynchronous loop. This is done by the ``spade.run()`` function. This function receives a coroutine as a parameter
130130
and runs it in an async loop. In our example, the ``main()`` coroutine is the one that is run in the loop.
131131

132132
.. note:: If you need to run a set of agents in parallel you can use the ``spade.start_agents(agent_list)`` function. This function

docs/web.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ click the behaviour's name to see more information about it as in the next image
3535
:alt: SPADE behaviour page
3636

3737
In this page you can check some important information about the behaviour such as its mailbox, the template with which
38-
it was registered, wether if it is killed or not or its exit code. Also, each type of behaviour may show any information
38+
it was registered, whether it is killed or not or its exit code. Also, each type of behaviour may show any information
3939
related with its internal data, e.g. in the previous image you can see that the behaviour is an FSMBehaviour and the
4040
interface shows the current state where the FSM is and an image with the structure of the FSM.
4141
Finally, you can also check all the messages that have been sent or received from/to this behaviour in the chat box.

0 commit comments

Comments
 (0)