Skip to content

Commit

Permalink
Update README.md Documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
shreysrins authored Feb 17, 2022
1 parent 1831633 commit c111c43
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,8 @@ $ pip3 install fixedincome-analytics -U
```

## Documentation
Documentation is available through Python's built-in `help()` function.
Documentation is available through Python's built-in `help()` function. As an example, we can see package-level documentation using the following Python code:
```python3
import fixedincome as fi
help(fi)
```

0 comments on commit c111c43

Please sign in to comment.