Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Jochem Berends committed Sep 1, 2017
1 parent 00418a4 commit 2470468
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions pykechain/models/part.py
Original file line number Diff line number Diff line change
Expand Up @@ -328,15 +328,15 @@ def delete(self):
raise APIError("Could not delete part: {} with id {}".format(self.name, self.id))

def edit(self, name=None, description=None, **kwargs):
# type: (AnyStr, AnyStr) -> None
# type: (AnyStr, AnyStr, Any) -> None
"""
Edit the details of a part (model or instance).
For an instance you can edit the Part instance name and the part instance description
:param name: optional name of the part to edit
:param description: (optional) description of the part
:param kwargs: (optional)
:param kwargs: (optional) additional kwargs that will be passed in the during the edit/update request
:return: None
:raises: APIError
Expand Down Expand Up @@ -403,6 +403,7 @@ def update(self, name=None, update_dict=None, bulk=True, **kwargs):
:param name: new part name (defined as a string)
:param update_dict: dictionary with keys being property names (str) and values being property values
:param bulk: True to use the bulk_update_properties API endpoint for KE-chain versions later then 2.1.0b
:param kwargs: (optional) additional keyword arguments that will be passed inside the update request
:return: :class:`pykechain.models.Part`
:raises: APIError, Raises `NotFoundError` when the property name is not a valid property of this part
Expand Down Expand Up @@ -442,6 +443,7 @@ def add_with_properties(self, model, name=None, update_dict=None, bulk=True, **k
:param name: (optional) name provided for the new instance as string otherwise use the name of the model
:param update_dict: dictionary with keys being property names (str) and values being property values
:param bulk: True to use the bulk_update_properties API endpoint for KE-chain versions later then 2.1.0b
:param kwargs: (optional) additional keyword arguments that will be passed inside the update request
:return: :class:`pykechain.models.Part`
:raises: APIError, Raises `NotFoundError` when the property name is not a valid property of this part
Expand Down

0 comments on commit 2470468

Please sign in to comment.