Skip to content

Commit

Permalink
Clarify documentation of rebalance command
Browse files Browse the repository at this point in the history
Added some documentation to clarify that lak analyze rebalance command
only prints asset classes that are outside the bounds.

Fixes #44.
  • Loading branch information
sarvjeets committed Feb 26, 2022
1 parent 41313a4 commit 08a1a33
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/lak.md
Original file line number Diff line number Diff line change
Expand Up @@ -1412,8 +1412,8 @@ Options:
$ lak analyze rebalance --help
Usage: lak analyze rebalance [OPTIONS]
Shows if assets needs to be rebalanced based on a band based rebalancing
scheme. For more information, please refer to
Shows if any asset classes need to be rebalanced based on a band based
rebalancing scheme. For more information, please refer to
https://www.whitecoatinvestor.com/rebalancing-the-525-rule/.
Options:
Expand All @@ -1432,6 +1432,15 @@ method. Currently, it also doesn't account for
be problematic. Taxation is a complex topic and users are _strongly_
advised to do their own research before using this tool.

The `rebalance` command only shows asset classes that don't fall within
the rebalancing bands. If all asset classes are within the bands, it prints
a message to that effect:

```
$ lak analyze rebalance
Portfolio Asset allocation within bounds.
```

### lak edit

This command is used to edit various parts of the portfolio. The
Expand Down
2 changes: 1 addition & 1 deletion lakshmi/lak.py
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@ def tlh(max_percentage, max_dollars):
show_default=True,
help='The max relative difference before rebalancing.')
def rebalance(max_abs_percentage, max_relative_percentage):
"""Shows if assets needs to be rebalanced based on a band
"""Shows if any asset classes need to be rebalanced based on a band
based rebalancing scheme. For more information, please refer to
https://www.whitecoatinvestor.com/rebalancing-the-525-rule/."""
global lakctx
Expand Down

0 comments on commit 08a1a33

Please sign in to comment.