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

Python documentation #5337

Closed
zwimer opened this issue Jun 9, 2021 · 1 comment
Closed

Python documentation #5337

zwimer opened this issue Jun 9, 2021 · 1 comment

Comments

@zwimer
Copy link
Contributor

zwimer commented Jun 9, 2021

The documentation for python's Extract is incorrect / complete. The args are high, low, a, yet that is only one possible case. There others; in fact the example given simplify(Extract(StringVal("abcd"),2,1)) needs args labeled something like a, start, count.

Related, functions that call extract have incomplete docs. For example, SubString; which shows passing Extract the args s, offset, length. But since this is just a passthrough, high, low, and a work as well. The docs should say this so that if one mistypes the order, it won't bunt the issue down the line for when some other function gets the wrong input since SubString output something unexpected. SubSeq also passes through.

NikolajBjorner added a commit that referenced this issue Jun 15, 2021
Signed-off-by: Nikolaj Bjorner <nbjorner@microsoft.com>
@NikolajBjorner
Copy link
Contributor

I added some more explanation for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants