From dd8814d3232b272f45fd7fbb8319f7930632f502 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Mon, 12 May 2025 16:35:49 -0600 Subject: [PATCH 1/3] fix: bad links --- TRANSLATING.md | 12 ++++++------ documentation/repository-files/intro.md | 2 +- package-structure-code/code-style-linting-format.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/TRANSLATING.md b/TRANSLATING.md index 811b2c7ea..41c510a17 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -36,10 +36,10 @@ First, fork the guide repository into your personal GitHub account and clone the To create a virtual environment and install the development dependencies for the guide, run the following commands: ```shell -$ cd ./python-package-guide -$ python -m venv .venv -$ source .venv/bin/activate -$ pip install .[dev] +cd ./python-package-guide +python -m venv .venv +source .venv/bin/activate +pip install .[dev] ``` TODO: This section needs more work or to be replaced with a reference to the CONTRIBUTING guide. @@ -75,7 +75,7 @@ The translation files contain the original English text and a space for you to e You can do this by running the following command, replacing LANG by the language code you plan to work on (e.g., `es` for Spanish): ```shell -$ nox -s update-language -- LANG +nox -s update-language -- LANG ``` This command will create the translation files if they don't exist yet, or update them with the latest changes if they already exist. @@ -287,7 +287,7 @@ If a language is ready to go live, the maintainers will add the language code to When the guide is built for release in CI, Sphinx will also generate the translated versions of the guide for the languages in the `RELEASE_LANGUAGES` list. -Translations are released in the same way as the English version of the guide, and the translated versions will be available in folders named after the language code. For example, the Spanish translation will be available in [https://www.pyopensci.org/python-package-guide/es/](https://www.pyopensci.org/python-package-guide/es/). +Translations are released in the same way as the English version of the guide, and the translated versions will be available in folders named after the language code. For example, the Spanish translation will be available at: `https://www.pyopensci.org/python-package-guide/es/` when it is published online. ## Frequently Asked Questions (FAQ) diff --git a/documentation/repository-files/intro.md b/documentation/repository-files/intro.md index f7c91c450..31117b8bf 100644 --- a/documentation/repository-files/intro.md +++ b/documentation/repository-files/intro.md @@ -16,7 +16,7 @@ name: moving-pandas-github-community width: 80% alt: Image showing that the MovingPandas GitHub repository community health page with green checks next to each file including a description, README, code of conduct, contributing, license and issue templates. Note that Security policy has a yellow circle next to it as that is missing from the repo. --- -GitHub community health looks for a readme file among other elements when it evaluates the community level health of your repository. This example is from the [MovingPandas GitHub repo](https://github.com/anitagraser/movingpandas/community) *(screen shot taken Nov 23 2022)* +GitHub community health looks for a readme file among other elements when it evaluates the community level health of your repository. This example is from the [MovingPandas GitHub repo](https://github.com/movingpandas/movingpandas/community) *(screen shot taken Nov 23 2022)* ``` [Snyk](https://snyk.io/advisor/python) is another well-known company that diff --git a/package-structure-code/code-style-linting-format.md b/package-structure-code/code-style-linting-format.md index bb4a9dba0..7e92c0eed 100644 --- a/package-structure-code/code-style-linting-format.md +++ b/package-structure-code/code-style-linting-format.md @@ -262,7 +262,7 @@ You type and run: The pre-commit workflow begins with you adding files that have changes to be staged in git. Next, you'd run git commit. When you run git commit, the pre-commit hooks will then run. In this example, Black, the code formatter and flake8, a linter both run. If all of the files pass Black and flake8 checks, then your commit will be recorded. If they don't, the commit is canceled. You will have to fix any flake8 issues, -and then re-add / stage the files to be committed. [_Image Source_](https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/*) +and then re-add / stage the files to be committed. [_Image Source_](https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/) :::