Skip to content

Commit

Permalink
docs: add EventsList in engine.rst (#1645)
Browse files Browse the repository at this point in the history
* fix(EventsList): remove heading whitespace

* docs: add EventsList in engine.rst
  • Loading branch information
Jeff Yang authored Feb 16, 2021
1 parent b47b1ec commit 63a6f1b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/source/engine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,8 @@ ignite.engine.events

.. autoclass:: EventEnum

.. autoclass:: EventsList

.. autoclass:: State

.. autoclass:: RemovableEventHandle
Expand Down
2 changes: 1 addition & 1 deletion ignite/engine/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ def call_on_events(engine):
or
.. code-block:: python
.. code-block:: python
@engine.on(Events.STARTED | Events.COMPLETED | Events.ITERATION_STARTED(every=3))
def call_on_events(engine):
Expand Down

0 comments on commit 63a6f1b

Please sign in to comment.