From 5e22ce0c333361aabeb12ba27f5876f12590de2a Mon Sep 17 00:00:00 2001 From: Heidi Kristenson <61886203+hjkristenson@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:24:06 -0800 Subject: [PATCH 1/3] change readme link to full URL This PR replaces the relative link with the full URL for the watermasking readme so that the link will also work in hyp3-docs, which references this readme file for the asf_tools information page. --- src/asf_tools/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/asf_tools/README.md b/src/asf_tools/README.md index 7afba99..86543ba 100644 --- a/src/asf_tools/README.md +++ b/src/asf_tools/README.md @@ -166,5 +166,5 @@ For details on the algorithm see the `asf_tools.flood_map.make_flood_map` docstr The `asf_tools.watermasking` sub-package allows you to create a watermasking dataset over an arbitrary ROI using OpenStreetMap and ESA WorldCover data. -Note, this program requires `osmium-tool`. See [README.md](watermasking/README.md) -for more information on setup and usage. \ No newline at end of file +Note, this program requires `osmium-tool`. See the [watermasking subpackage readme]([watermasking/README.md](https://github.com/ASFHyP3/asf-tools/blob/main/src/asf_tools/watermasking/README.md)https://github.com/ASFHyP3/asf-tools/blob/main/src/asf_tools/watermasking/README.md) +for more information on setup and usage. From 24b31b691d230c3a699b72f61dd178f22234293e Mon Sep 17 00:00:00 2001 From: Heidi Kristenson <61886203+hjkristenson@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:28:29 -0800 Subject: [PATCH 2/3] update changelog --- CHANGELOG.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a1c22b..7c0072a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/) and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [0.7.2] + +### Fixed +- Changed relative link to the watermasking readme in the repo readme to the full URL, so that the link is valid when readme content is mirrored in hyp3-docs + ## [0.7.1] ### Added @@ -18,7 +23,7 @@ and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [0.7.0] -## Added +### Added * Scripts and entrypoints for generating our global watermasking dataset added to `watermasking`. ## [0.6.0] From 3d4a029dd767406a41a45e7794b4d92b7a7d4112 Mon Sep 17 00:00:00 2001 From: Heidi Kristenson <61886203+hjkristenson@users.noreply.github.com> Date: Wed, 20 Mar 2024 10:35:38 -0800 Subject: [PATCH 3/3] remove copy-paste error --- src/asf_tools/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/asf_tools/README.md b/src/asf_tools/README.md index 86543ba..ec61af9 100644 --- a/src/asf_tools/README.md +++ b/src/asf_tools/README.md @@ -166,5 +166,5 @@ For details on the algorithm see the `asf_tools.flood_map.make_flood_map` docstr The `asf_tools.watermasking` sub-package allows you to create a watermasking dataset over an arbitrary ROI using OpenStreetMap and ESA WorldCover data. -Note, this program requires `osmium-tool`. See the [watermasking subpackage readme]([watermasking/README.md](https://github.com/ASFHyP3/asf-tools/blob/main/src/asf_tools/watermasking/README.md)https://github.com/ASFHyP3/asf-tools/blob/main/src/asf_tools/watermasking/README.md) +Note, this program requires `osmium-tool`. See the [watermasking subpackage readme](https://github.com/ASFHyP3/asf-tools/blob/main/src/asf_tools/watermasking/README.md) for more information on setup and usage.