Repository navigation
Complete doc strings in free function module - #2116
Merged
adam-urbanczyk merged 2 commits intoOct 23, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2116 +/- ##
=======================================
Coverage 95.81% 95.81%
=======================================
Files 30 30
Lines 9603 9603
Branches 1442 1442
=======================================
Hits 9201 9201
Misses 247 247
Partials 155 155 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
adam-urbanczyk
approved these changes
Oct 23, 2026
adam-urbanczyk
left a comment
adam-urbanczyk
left a comment
Member
There was a problem hiding this comment.
Thanks @DavidMStraub !
Co-authored-by: AU <adam-urbanczyk@users.noreply.github.com>
Member
|
Docstring update, so I'm going to merge without additional reviews. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hi,
I love the free function API, but the two species I work with – students and agents – often struggle with the functions in
cq.funcbecause the doc strings are so spartanic that it can be unclear what the function parameters mean, or how the operations work.This PR should complete the parameter documentation for all of them and also contains some helpful explanations about underlying behaviour, where appropriate.