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

DFA implementation conflicts with the docs #248

Closed
dsr20030703 opened this issue Feb 26, 2025 · 2 comments
Closed

DFA implementation conflicts with the docs #248

dsr20030703 opened this issue Feb 26, 2025 · 2 comments

Comments

@dsr20030703
Copy link

In the automata.fa.dfa.DFA.__init__ function ,the docstring says: allow_partial : bool, default: True.
The DFA document also says that the default value of allow_partial is True.
However, in the parameter list of the function, it codes allow_partial: bool = False.

@caleb531
Copy link
Owner

@dsr20030703 I've added a note to get this fixed. Thank you for reporting this discrepancy!

cc @eliotwrobson

@caleb531
Copy link
Owner

@dsr20030703 Okay, I've tweaked the docstring and redeployed the documentation site. The library will have the docstring fix reflected in the help() message upon the next release.

All that to say, I'm considering this issue completed, and closing it out. Thank you again for kindly reporting the disparity!

Image

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

No branches or pull requests

2 participants