Commit bc5eafa1 authored by Jiahang Chen's avatar Jiahang Chen
Browse files

update doc

parent d4466fa7
Pipeline #367807 passed with stages
in 34 seconds
......@@ -162,11 +162,11 @@
def build_sub_features(feature_ins, feature):
"""
build the ml40/fml40 sub features
Build a ml40/fml40 sub features
:param feature_ins: ml40/fml40 feature instance
:param feature_ins: ml40/fml40 feature instance, which has a sub feature to be built
:type feature_ins: object
:param feature: ml40/fml40 feature
:param feature: ml40/fml40 feature containing subFeatures
:type feature: dict
"""
......@@ -191,11 +191,11 @@ def build_sub_features(feature_ins, feature):
def build_sub_thing(feature_ins, feature):
"""
build fml40 sub thing to ml40/fml40 feature
Build and insert a sub thing into a feature instance
:param feature_ins: ml40/fml40 feature instance
:type feature_ins: object
:param feature: ml40/fml40 feature
:param feature: ml40/fml40 feature, which contains a sub thing
:type feature: dict
"""
......@@ -208,7 +208,7 @@ def build_sub_thing(feature_ins, feature):
def build(thing, attributes):
"""
build ml40 thing
Build a ml40 thing instance
:param thing: ml40 thing instance
:type thing: object
......@@ -232,7 +232,7 @@ def build(thing, attributes):
def build_role(role):
"""
build ml40/fml40 role in a ml40 thing instance
Build and insert a ml40/fml40 role in a ml40 thing instance
:param role: ml40/fml40 role
:type role: dict
......@@ -251,7 +251,7 @@ def build_role(role):
def build_feature(feature):
"""
build ml40/fml40 feature in a ml40 thing instance
Build and insert a ml40/fml40 feature in a ml40 thing instance
:param feature: ml40/fml40 feature
:type feature: dict
......@@ -280,7 +280,7 @@ def build_feature(feature):
def add_function_impl_obj(thing, impl_obj, feature_name):
"""
add user-specific implemented object to a thing instance
Add user-specific implemented object to a thing instance
:param thing: ml40 thing instance
:type thing: object
......@@ -307,7 +307,7 @@ def create_thing(model, grant_type="password",
secret="", username=None, password=None,
is_broker_rest=False, is_broker=False, is_repo=False):
"""
create a ml40 thing instance
Create and launch a ml40 thing with the connection to S³I
:param model: JSON of a ml40::thing model
:type model: dict
......
......@@ -125,7 +125,8 @@ def make_thing_config(thing_id, name, roles, features=[], config_path=""):
def load_config(config_filepath):
"""load a json object from a json formatted file found at config_filepath.
"""
Load a json object from a json formatted file found at config_filepath.
:param config_filepath: Path to json formatted file.
:type config_filepath: str
......@@ -138,7 +139,7 @@ def load_config(config_filepath):
def find_broker_endpoint(dir_obj, thing_id):
"""
find the S3I-B endpoint of a thing
Find the S3I-B endpoint of a thing
:param dir_obj: S³I Directory Object
:type dir_obj: object
......@@ -155,7 +156,7 @@ def find_broker_endpoint(dir_obj, thing_id):
def remove_namespace(input_str):
"""
remove the namespace like ml40 or fml40
Remove the specified namespace like ml40 or fml40
:param input_str: input with namespace
:type input_str: str
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment