Skip to content

Commit a8c522e

Browse files
committed
Update docs
1 parent 1bd2f6f commit a8c522e

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The target audience is someone who is quite hands-on with their tools, in the sa
2525

2626
### What is it *not yet* good for?
2727

28-
* The tool supports only transactions with one source account and one target account. It does not support [splitting expenses][] as described in Beancount's documentation. For example, if there is a hotel bill that combines lodging, food and entertainment costs in one charge, this tool can not help with splitting that expense into three different expense accounts. **Workaroud**: manually edit the Beancount file after conversion.
28+
* The tool supports only transactions with one source account and one target account. It does not support [splitting expenses][] as described in Beancount's documentation. For example, if there is a hotel bill that combines lodging, food and entertainment costs in one charge, this tool can not help with splitting that expense into three different expense accounts. **Workaround**: manually edit the Beancount file after conversion.
2929
* The tool does not support transactions with currency exchanges.
3030

3131
## What does success look like for this project?

docs/reference/development.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,14 @@ pytest --cov --cov-report term
7777
Ref: [Digital Ocean](https://www.digitalocean.com/community/tutorials/how-to-publish-python-packages-to-pypi-using-poetry-on-ubuntu-22-04)
7878

7979
* [ ] Bump version
80-
* [ ] `pyproject.toml`
81-
* [ ] `src/beancount_multitool/__version__.py`
82-
* [ ] Update [changelog](changelog.md)
80+
* [ ] `pyproject.toml`
81+
* [ ] `src/beancount_multitool/__version__.py`
82+
* [ ] Update [changelog](changelog.md)
8383
* [ ] Run local tests and coverage.
84-
* [ ] Update coverage number in project `README.md`.
85-
* [ ] `git commit` and check that GitHub Action tests succeed.
84+
* [ ] Update coverage number in project `README.md`.
85+
* [ ] `git commit`
86+
* [ ] Check that the [test](../../.github/workflows/tests.yml) GitHub Action succeed.
87+
* [ ] Docs are build with a [GitHub Action](../../.github/workflows/docs.yml).
8688
* [ ] `git tag -a v0.5.0 -m "v0.5.0"`
8789
* [ ] `poetry build`
8890
* [ ] `poetry publish`

0 commit comments

Comments
 (0)