-
Notifications
You must be signed in to change notification settings - Fork 21
Improve function help by grouping by function type #263
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
base: master
Are you sure you want to change the base?
Conversation
ccf5ec7 to
ea59e3a
Compare
b7beaf0 to
187d474
Compare
|
Thanks for looking into improving the help system. I only went very quickly through the changes, but I feel that most of what you add some come in the form of documentation rather than in form of verbose help commands. Quite a few functions are deprecated and should be hidden from the help completely (or by default, or at least clearly marked as deprecated). |
|
I am not sure I understand your point, did you mean: "I feel that most of what you add should come in the form of documentation..."? I would be happy to help with the documentation, however, at least in the beancount docs the |
|
@dnicolodi Hi, I was just wondering if there is anything I could do to move this forward. I find this tool very useful and would lovehto help improve it! |
…tions, as well as position and inventory functions
2704a02 to
1ef3360
Compare
1ef3360 to
d0766ec
Compare
As someone new to beancount, I found the function documentation really hard to navigate. The old
help functionsdumped everything on screen at once, which was overwhelming. While developing a BQL query, I found myself looking for functions to transform certain argument types, however I just had an alphabetical function list. (Re-open of #262)What I changed:
Progressive disclosure:
help functionsnow shows just a category overview (takes ~10 lines instead of 100+) and explains custom object typeshelp functions amountshows only amount-related functions, same fordate,position,atomic,...Better function docs:
grep(pattern, string)now explains "pattern" is a regex and "string" is input textPositionis something like10 HOOL {100.30 USD}Technical implementation:
_describe_function().@function,@registerand@aggregatortake agroup=argument to refine (e.g. for account names, which are strings)The main benefit is you can find functions now much easier without scrolling through pages of text. When I started with beancount, I had no idea what functions were available or how to use them - I hope this makes it easier.