From dcda747578b00fd936ed7ac1b9d17fc6a01f980d Mon Sep 17 00:00:00 2001 From: Sam Cunliffe Date: Wed, 27 Mar 2024 12:09:32 +0000 Subject: [PATCH] Add refactoring.md and tweak virtual environments docs (take 2) (#341) I took over - #265 rebased and made a tweak. This PR now only closes - #257 --- Questions that come to mind: - Do we even want a separate refactoring page any more? - Has anyone ever actually used rope? - Dev tools is now quite short. --------- Co-authored-by: ruaridhg Co-authored-by: ruaridhg <32329546+ruaridhg@users.noreply.github.com> Co-authored-by: David Stansby --- .../{benchmarking.md => benchmarking-profiling.md} | 0 docs/pages/refactoring.md | 12 ++++++++++++ docs/pages/utilities.md | 6 ++++++ docs/pages/{dev.md => virtual.md} | 10 +--------- 4 files changed, 19 insertions(+), 9 deletions(-) rename docs/pages/{benchmarking.md => benchmarking-profiling.md} (100%) create mode 100644 docs/pages/refactoring.md rename docs/pages/{dev.md => virtual.md} (56%) diff --git a/docs/pages/benchmarking.md b/docs/pages/benchmarking-profiling.md similarity index 100% rename from docs/pages/benchmarking.md rename to docs/pages/benchmarking-profiling.md diff --git a/docs/pages/refactoring.md b/docs/pages/refactoring.md new file mode 100644 index 00000000..d3fc49a5 --- /dev/null +++ b/docs/pages/refactoring.md @@ -0,0 +1,12 @@ +--- +title: Refactoring tools +layout: default +--- + +# Refactoring Tools + +| Name | Short description | 🚦 | +| ----------------------------------------------------------- | -------------------------------------------------------------- | --- | +| [jedi](https://jedi.readthedocs.io/en/stable/) | Refactoring and autocompletion used in IDEs. | 🟢 | +| [sourcery.ai](https://sourcery.ai) | Refactoring suggestions and code review. Free for open source. | 🟠 | +| [rope](https://rope.readthedocs.io/en/stable/overview.html) | Refactoring library. | 🟠 | diff --git a/docs/pages/utilities.md b/docs/pages/utilities.md index bce35085..ff3f544d 100644 --- a/docs/pages/utilities.md +++ b/docs/pages/utilities.md @@ -24,3 +24,9 @@ want to write these yourself but might need logging or a command-line interface. | --------------------------------------------------------- | -------------------------------------------------------------------- | :-: | | [loguru](https://loguru.readthedocs.io/) | Simple and user-friendly with many nice features enabled by default. | 🟢 | | [logging](https://docs.python.org/3/library/logging.html) | Python's builtin logging framework. Needs some configuration. | 🟠 | + +## User interface + +| Name | Short description | 🚦 | +| -------------------------------------------- | ----------------------- | :-: | +| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 | diff --git a/docs/pages/dev.md b/docs/pages/virtual.md similarity index 56% rename from docs/pages/dev.md rename to docs/pages/virtual.md index a3bf5d8c..6e189cb1 100644 --- a/docs/pages/dev.md +++ b/docs/pages/virtual.md @@ -1,5 +1,5 @@ --- -title: Dev tools +title: Virtual environments layout: default --- @@ -12,11 +12,3 @@ layout: default | [pyenv](https://github.com/pyenv/pyenv) | Lets you easily switch between multiple versions of Python. | 🟠 | | [virtualenv](https://virtualenv.pypa.io/en/latest/) | Creates isolated Python environments, and offers more features than venv. | 🟠 | | [venv](https://docs.python.org/3/library/venv.html) | Creates isolated Python environments. | 🔴 | - -# Other - -| Name | Short description | 🚦 | -| ----------------------------------------------------------- | -------------------------------------------------------------------------------------- | :-: | -| [jedi](https://jedi.readthedocs.io/en/latest/) | Refactoring and autocompletion used in for integrated development environments (IDEs). | 🟢 | -| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library. | | -| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 |