Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: Include CheckManpage and CheckTexinfo in tests #2309

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

afh
Copy link
Member

@afh afh commented Dec 5, 2023

While debugging #2302 I noticed that CheckManpage.py and CheckTexinfo.py are not included in the test suite. I believe it is safe to include them even though they currently fail due to missing documentation for a few options and functions (see below), because the tests can only be run if ledger has been built with debug support as the CheckManpage.py and CheckTexinfo.py (via CheckOptions.py) use the ledger option --debug option.names parse true which only provides useful information with built with debug support.

@jwiegley from the top of your head could you provide a short description for the following missing option and function documentation (I'm happy to accept this here as a PR comment and take care of the manpage and texinfo syntax)?

$ python test/CheckManpage.py -l ./result-debug/bin/ledger -s .
Missing manpage option entries for:
  --sort-all

Missing manpage function entries for:
  averaged_lots
  clear_commodity
  commodity_price
  display_amount
  display_total
  lot_date
  lot_price
  lot_tag
  nail_down
  round
  rounded
  set_commodity_price
  top_amount
  unround
  unrounded

$ python test/CheckTexinfo.py -l ./result-debug/bin/ledger -s .
Missing texinfo option entries for:
  --sort-all

Missing texinfo function entries for:
  averaged_lots
  clear_commodity
  commodity_price
  lot_date
  lot_price
  lot_tag
  nail_down
  round
  rounded
  set_commodity_price
  top_amount
  unround
  unrounded

@afh afh requested a review from jwiegley December 5, 2023 08:25
@afh afh self-assigned this Dec 5, 2023
@afh afh added enhancement New feature or request documentation Related to the documentation tests Related to ledger's test suite labels Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to the documentation enhancement New feature or request tests Related to ledger's test suite
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant