From da684f6edd017fbb42c19e98e3cdc60a79995871 Mon Sep 17 00:00:00 2001 From: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Date: Sat, 25 Nov 2023 08:44:31 +0100 Subject: [PATCH] minor edits --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fcc049c..2343543 100644 --- a/README.md +++ b/README.md @@ -131,10 +131,10 @@ Please follow the extensive guide we have provided [on the documentation website What if you want to update the [docstrings](https://en.wikipedia.org/wiki/Docstring) of a Brightway package (eg. `bw2data`) and check if they render correctly in the documentation? You can do this by updating the submodule `brightway2-data`. -1. Use the `git submodule set-url` command to update the URL of the submodule: +1. Use the [`git submodule set-url`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-set-url--ltpathgtltnewurlgt) command to update the URL of the submodule: > [!NOTE] -> Replace `brightway2-data` with the name of the submodule you want to update. +> Replace `brightway2-data` with the name of the submodule you want to update. \ > Replace `https://github.com/michaelweinold/brightway2-data` with the URL of the submodule you want to update. ```bash @@ -150,7 +150,7 @@ This will update the URL in the `.gitmodules` file and in the `.git/config` file branch = main ``` -2. Use the `git submodule update` command to update the submodule: +2. Use the [`git submodule update`](https://git-scm.com/docs/git-submodule#Documentation/git-submodule.txt-update--init--remote-N--no-fetch--no-recommend-shallow-f--force--checkout--rebase--merge--referenceltrepositorygt--depthltdepthgt--recursive--jobsltngt--no-single-branch--filterltfilterspecgt--ltpathgt82308203) command to update the submodule: ```bash git submodule update --init --recursive --remote