Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some spelling and grammar on the user manual #1210

Merged
merged 1 commit into from
Jun 15, 2020
Merged

Fix some spelling and grammar on the user manual #1210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/source/traits_user_manual/notification.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ See :ref:`on-trait-change-notification` for details on this older API.
Requesting trait attribute change notifications can be done in these
ways:

* Via class defintion: By decorating methods on the class with the |@observe|
* Via class definition: By decorating methods on the class with the |@observe|
decorator to indicate that they handle notification for specified attributes.
* Via instance method: By calling |HasTraits.observe| instance method to establish (or remove) change
notification handlers.
Expand Down Expand Up @@ -51,7 +51,7 @@ Via instance method
-------------------

The |HasTraits.observe| method on |HasTraits| is useful for adding or removing
change handler on a per instance basis. The example above can be rewritten like
change handlers on a per instance basis. The example above can be rewritten like
this:

.. literalinclude:: /../../examples/tutorials/doc_examples/examples/observe_method.py
Expand Down Expand Up @@ -90,7 +90,7 @@ Traits Mini Language is a domain specific language which provides a convenient
and concise way to specify observation rules via a single text. It supports
most of the use cases commonly encountered by users.

.. rubric:: Sementics of Traits DSL
.. rubric:: Semantics of Traits DSL

.. list-table::
:widths: 15 25
Expand Down Expand Up @@ -128,7 +128,7 @@ most of the use cases commonly encountered by users.
*updated*. Changes on those traits and changes on *foo* will trigger
notifications.
* - ``"foo,bar"``
- Matches trait named *foo* or *bar* on the current object. Changes on
- Matches traits named *foo* or *bar* on the current object. Changes on
*foo* or *bar* will trigger notifications.
* - ``"foo:[bar,baz]"``
- Matches *foo.bar* or *foo.baz* on the current object. Changes on
Expand Down Expand Up @@ -207,15 +207,15 @@ notifications should be fired for changes.
*updated*. Changes on those traits will trigger notifications.

* ``trait("foo") | trait("bar")``
Matches trait named *foo* or *bar* on the current object. Changes on
Matches traits named *foo* or *bar* on the current object. Changes on
*foo* or *bar* will trigger notifications.

* ``trait("foo").then(trait("bar") | trait("baz"))``
Matches *foo.bar* or *foo.baz* on the current object. Changes on *foo*,
*foo.bar* or *foo.baz* will trigger notifications.

* ``trait("foo").match(lambda n, t: True)``
Matches any traits on *foo* on the current object. Changes on *foo* or
Matches all traits on *foo* on the current object. Changes on *foo* or
the nested attributes will trigger notifications.

.. rubric:: Extend an expression in text
Expand All @@ -234,13 +234,13 @@ Notification Handler
--------------------

By default, the **handler** is invoked immediately after the change has
occured. The **dispatch** parameter in |@observe| can be set such that the
occurred. The **dispatch** parameter in |@observe| can be set such that the
handler is dispatched elsewhere to be invoked later (e.g. on a GUI event loop).

The following expectations apply to any change handler:

* It must accept one argument: the **event** parameter (see below)
* It is called **after** a change has occured
* It is called **after** a change has occurred
* No assumptions should be made about the order of which handlers are called
for a given change event. A change event can have many change handlers.
* No exceptions should be raised from a change handler. Any unexpected
Expand Down Expand Up @@ -595,8 +595,8 @@ Syntax "-" is not supported
```````````````````````````

With |@on_trait_change|, the syntax *"-metadata_name"* is used to notify
for changes on traits that do NOT have a metadata with the give name. This
usage can be replaced by |match|::
for changes on traits that do NOT have a metadata attribute with the given
name. This usage can be replaced by |match|::

match(lambda name, trait: trait.metadata_name is None)

Expand Down