search

caleb531 / automata

A Python library for simulating finite automata, pushdown automata, and Turing machines
https://caleb531.github.io/automata/
MIT License
348 stars 64 forks source link

docs: Additions for review #217

Closed eliotwrobson closed 5 months ago

eliotwrobson commented 5 months ago

Work in progress performance documentation examples for #213. Will write second example shortly.

EDIT: Added second example. @phildong these should be ready to try locally!

EDIT 2: Added note for issues with graphviz installation https://github.com/caleb531/automata/issues/223, an example for NFA instantiation https://github.com/caleb531/automata/issues/220, and the first part of https://github.com/caleb531/automata/issues/221 @irisdyoung

Corresponding review: https://github.com/pyOpenSci/software-submission/issues/152

coveralls commented 5 months ago

Coverage Status

coverage: 99.613% (+0.001%) from 99.612% when pulling 0956873d4056dd2fe6cf78b65136124d913819a1 on eliotwrobson:docs_benchmarks into 530016a03703e071b72f1665769770039018536d on caleb531:develop.

caleb531 commented 5 months ago

@eliotwrobson Is this ready for my review yet? I would ask that any work-in-progress PRs be kept in Draft state until they are ready for my final approval.

eliotwrobson commented 5 months ago

@caleb531 not quite yet, this PR is in the unique situation where we're really waiting on approval by the reviewers that opened the original issue. They may ask for more changes, so makes sense to leave as a draft for now 👍