methodical icon indicating copy to clipboard operation
methodical copied to clipboard

Refactor Move Describable to methodical.interface

Open AbhinavOmprakash opened this issue 3 years ago • 0 comments

Thanks for contributing to Methodical. Before open a pull request, please take a moment to:

  • [x] Ensure the PR follows the Clojure Style Guide.

  • [x] Tests and linters pass. You can run all of the tests and linters locally with

    ./scripts/lint-and-test.sh
    

    GitHub Actions will also run these same tests against your PR.

  • [x] Make sure you've included new tests for any new features or bugfixes.

  • [x] New features are documented, or documentation is updated appropriately for any changed features.

  • [x] Carefully review your own changes and revert any superfluous ones. (A good example would be moving words in the Markdown documentation to different lines in a way that wouldn't change how the rendered page itself would appear. These sorts of changes make a PR bigger than it needs to be, and, thus, harder to review.)

    Of course, indentation and typo fixes are not covered by this rule and are always appreciated.
    
  • [x] Include a detailed explanation of what changes you're making and why you've made them. This will help me understand what's going on while we review it.

Once you've done all that, open a PR! Thanks for your contribution!

This PR closes #128

  • I have moved the contents of the file methodical.util.describe to methodical.interface.
  • I have refactored the occurrences of Describable as well.
  • And I've deleted the methodical.util.describe namespace.
  • The diff looks bigger than it is because of my formatter. I couldn't find a formatter in the deps.edn file (so let me know if you want me to reformat it with a specific formatter with a specific config.

AbhinavOmprakash avatar Oct 18 '22 03:10 AbhinavOmprakash