Skip to content

Commit

Permalink
Merge pull request #1364 from ddebrunner/toc_docs_1
Browse files Browse the repository at this point in the history
Add toc/module contents
  • Loading branch information
ddebrunner committed Dec 20, 2017
2 parents 1bffb2b + 677188b commit c4fda97
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,30 @@
# Licensed Materials - Property of IBM
# Copyright IBM Corp. 2017

"""
SPL toolkit integration.
.. toctree::
:maxdepth: 4
streamsx.spl.toolkit
Overview
########
SPL operators are defined by an SPL toolkit. When a ``Topology``
contains invocations of SPL operators, their defining toolkit must
be made known using :py:func:`add_toolkit`.
Toolkits shipped with the IBM Streams product under
``$STREAMS_INSTALL/toolkits`` are implictly known and
must not be added through ``add_toolkit``.
Module contents
###############
"""

import os
from streamsx.topology.topology import Topology

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,21 @@
"""
SPL type definitions.
.. toctree::
:maxdepth: 4
streamsx.spl.types
Overview
########
SPL is strictly typed, thus when invoking SPL operators
using classes from ``streamsx.spl.op`` then any parameters
must use the SPL type required by the operator.
Module contents
###############
"""

import datetime
Expand Down Expand Up @@ -133,6 +144,9 @@ def int16(value):
def int32(value):
"""
Create an SPL ``int32`` value.
Args:
value(int): Value to be types as ``int32``.
"""
return Expression('INT32', int(value))

Expand Down

0 comments on commit c4fda97

Please sign in to comment.