Skip to content

Commit

Permalink
20495: Updates docstring for methods that modify cases (#271)
Browse files Browse the repository at this point in the history
Co-authored-by: howsohazard <[email protected]>
  • Loading branch information
howsoRes and howsohazard authored Aug 26, 2024
1 parent 360e600 commit cf140fd
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
9 changes: 9 additions & 0 deletions howso/client/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -884,6 +884,9 @@ def edit_cases(
"""
Edit feature values for the specified cases.
Updates the accumulated data mass for the model proportional to the
number of cases and features modified.
Parameters
----------
trainee_id : str
Expand Down Expand Up @@ -4328,6 +4331,9 @@ def add_feature(
"""
Adds a feature to a trainee.
Updates the accumulated data mass for the model proportional to the
number of cases modified.
Parameters
----------
trainee_id : str
Expand Down Expand Up @@ -4420,6 +4426,9 @@ def remove_feature(
"""
Removes a feature from a Trainee.
Updates the accumulated data mass for the model proportional to the
number of cases modified.
Parameters
----------
trainee_id : str
Expand Down
9 changes: 9 additions & 0 deletions howso/engine/trainee.py
Original file line number Diff line number Diff line change
Expand Up @@ -1974,6 +1974,9 @@ def edit_cases(
"""
Edit feature values for the specified cases.
Updates the accumulated data mass for the model proportional to the
number of cases and features modified.
Parameters
----------
feature_values : DataFrame or 2-dimensional list of object
Expand Down Expand Up @@ -2313,6 +2316,9 @@ def add_feature(
"""
Add a feature to the model.
Updates the accumulated data mass for the model proportional to the
number of cases modified.
Parameters
----------
feature : str
Expand Down Expand Up @@ -2388,6 +2394,9 @@ def remove_feature(
"""
Remove a feature from the trainee.
Updates the accumulated data mass for the model proportional to the
number of cases modified.
Parameters
----------
feature : str
Expand Down

0 comments on commit cf140fd

Please sign in to comment.