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

reorganize the project #2

Merged
merged 24 commits into from
Mar 17, 2020
Merged

reorganize the project #2

merged 24 commits into from
Mar 17, 2020

Conversation

keewis
Copy link
Owner

@keewis keewis commented Mar 16, 2020

At the moment, the structure of the project is one big script / module. While there is nothing immediately wrong with that, it also means that tests will be at the top-level and will have to installed explicitly and that extending the tool to also work with other formats like IPython prompts or rST / markdown code blocks is unnecessarily hard.

This refactors the project into a package with a __main__ module, more tests and a hook to register more formats. As a side-effect, it also introduces absolute line numbers to make debugging a lot easier.

Copy link
Owner Author

@keewis keewis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, but we should remove / refactor test_blackdoc.py

blackdoc/formats/doctest.py Outdated Show resolved Hide resolved
blackdoc/formats/doctest.py Outdated Show resolved Hide resolved
blackdoc/blacken.py Outdated Show resolved Hide resolved
blackdoc/blacken.py Show resolved Hide resolved
blackdoc/classification.py Outdated Show resolved Hide resolved
blackdoc/formats/__init__.py Outdated Show resolved Hide resolved
blackdoc/classification.py Outdated Show resolved Hide resolved
blackdoc/tests/test_doctest.py Outdated Show resolved Hide resolved
@keewis keewis merged commit 83076f3 into master Mar 17, 2020
@keewis keewis deleted the reorganization branch March 17, 2020 15:40
@keewis keewis mentioned this pull request May 23, 2020
7 tasks
@keewis keewis mentioned this pull request Oct 9, 2022
3 tasks
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