Repository navigation
Doc improvements #1463
Description
Is your feature request related to a problem or challenge? Please describe what you are trying to do.
I'm trying to use documentation to understand the arguments to functions in functions.py.
Describe the solution you'd like
I'd love if all the function docstrings had documentation for the arguments to the function. For example, alias has descriptions of its arguments.
Describe alternatives you've considered
None, really, just recording it as a unit of work that would improve the project.
Additional context
This is a follow-on issue to @ntjohnson1 excellent work in #1435 where he added tons of helpful examples. I was browsing the code in the PR and realized quite a few functions were missing argument documentation.
Activity
ntjohnson1 commentedon Apr 2, 2026
I agree on the ticket. However, most of the doc strings just explain what the arguments do. There were 153 functions without documented args and when I had claude make an automated pass on this it felt very redundant. All of that to say I won't have a chance to tackle this this week. Would be great if someone else made a pass on it, if not this is still very much on my backburner.