diff --git a/TRANSLATING.md b/TRANSLATING.md index 811b2c7ea..25e5170d3 100644 --- a/TRANSLATING.md +++ b/TRANSLATING.md @@ -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/bibliography.bib b/bibliography.bib index dabeaefb0..1e4a87e62 100644 --- a/bibliography.bib +++ b/bibliography.bib @@ -38,6 +38,6 @@ @misc{creativecommonsShareAlikeCompatibilityGPLv32015 year = {2015}, month = sep, journal = {Creative Commons Wiki}, - url = {https://wiki.creativecommons.org/wiki/ShareAlike\_compatibility:\_GPLv3}, + url = {https://wiki.creativecommons.org/wiki/ShareAlike_compatibility:_GPLv3}, urldate = {2024-03-02} } 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/documentation/repository-files/license-files.md b/documentation/repository-files/license-files.md index 1144e2ed8..0346388ad 100644 --- a/documentation/repository-files/license-files.md +++ b/documentation/repository-files/license-files.md @@ -5,7 +5,7 @@ bibliography: (license-file)= -# License files for scientific Python open source software +# License files for Python open source software :::{button-link} :color: primary @@ -69,7 +69,7 @@ in some cases the license that you want is not available through that online process. :::{admonition} License recommendations from the SciPy package -[The SciPy documentation has an excellent overview of licenses.](https://docs.scipy.org/doc/scipy/dev/core-dev/index.html#licensing). One of the key elements +[The SciPy documentation has an excellent overview of licenses.](https://docs.scipy.org/doc/scipy/dev/core-dev/index.html#licensing) One of the key elements that these docs recommend is ensuring that the license that you select is compatible with licenses used in many parts of the scientific Python ecosystem. Below is a highlight of this text which outlines license that are compatible 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/) :::