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

feat: Create programmatic API #30

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Create programmatic API #30

wants to merge 1 commit into from

Conversation

epage
Copy link
Contributor

@epage epage commented May 14, 2018

TODO

  • Determine how file_id_ref should be handled
  • Clarify intent on what parts of the API for meant for external use or not

Added spell_check_str

  • Doesn't requie file to be on disk
  • Does not read stdin or write to stdout
  • Acts as an iterator in the report-only use case
  • Acts as a coroutine in the auto-apply use case

Fixes #29

BREAKING CHANGE: spell_check_tokens API changed

Added `spell_check_str`
- Doesn't requie file to be on disk
- Does not read stdin or write to stdout
- Acts as an iterator in the report-only use case
- Acts as a coroutine in the auto-apply use case

Fixes myint#29

BREAKING CHANGE: `spell_check_token`s API changed
@epage
Copy link
Contributor Author

epage commented May 14, 2018

Determine how file_id_ref should be handled

When digging into the code, I could not see what impact mutating file_id_ref has.

Clarify intent on what parts of the API for meant for external use or not

Proposal:

  • __init__ continues to expose spell_check_str and everything needed to run it
  • Create cli.py
    • Move main and everything else not listed above into here
    • Add a _ prefix to all of these symbols to clarify intent of no one else using it.

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

Successfully merging this pull request may close these issues.

1 participant