From adb8cfc323373f01ef800ca68cd43b1591e5aab7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 26 Sep 2025 10:47:57 +0200 Subject: [PATCH 1/4] docs: :memo: minor text edits --- docs/design/index.qmd | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/design/index.qmd b/docs/design/index.qmd index 3d09d93..1ca77b1 100644 --- a/docs/design/index.qmd +++ b/docs/design/index.qmd @@ -2,15 +2,14 @@ title: "Design" --- -The purpose of these documents is to describe the design of -`check-datapackage` in enough detail to help us develop it in a way that -is sustainable (i.e., maintainable over the long term) and that ensures -we as a team have a shared understanding of what the package is and is -not. +The purpose of these design documents is to describe the design of +`check-datapackage` in enough detail to guide a sustainable implementation +(i.e., maintainable in the long term) and to ensure that +the team has a shared understanding of the package's scope and architecture before starting the development. `check-datapackage`'s design builds off of our overall Seedcase [design -principles and patterns](https://design.seedcase-project.org/), in that -any design we create for `check-datapackage` should strongly follow the +principles and patterns](https://design.seedcase-project.org/), and +strongly follows the same design principles and patterns described there. ## Purpose @@ -31,14 +30,16 @@ Specifically, `check-datapackage` should: Overall, `check-datapackage` must: -- Check Data Package descriptors against the Data Package standard. +- Check Data Package descriptors against the Data Package standard, specifically the Data Package [profiles](https://datapackage.org/standard/glossary/#profile). - Allow configuration to check or not check certain components of the descriptor. - Support turning off specific checks defined in the standard. - Support custom, user-defined checks in addition to those in the standard. -- Provide informative, user-friendly, and structured messages about +- Provide clear, user-friendly, and structured messages about any issues, identifying where in the descriptor the issues occur. +- Provide a strict mode that enforces all aspects of the Data + Package standard, including all recommendations. - Be designed in a way that can be extended as a command-line interface (CLI) in the future. From 8304b83df2102fd1ba3c4ca42d84bf426abc533e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 26 Sep 2025 10:48:29 +0200 Subject: [PATCH 2/4] style: :art: format `qmd` --- docs/design/index.qmd | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/design/index.qmd b/docs/design/index.qmd index 1ca77b1..ea0e99c 100644 --- a/docs/design/index.qmd +++ b/docs/design/index.qmd @@ -3,14 +3,15 @@ title: "Design" --- The purpose of these design documents is to describe the design of -`check-datapackage` in enough detail to guide a sustainable implementation -(i.e., maintainable in the long term) and to ensure that -the team has a shared understanding of the package's scope and architecture before starting the development. +`check-datapackage` in enough detail to guide a sustainable +implementation (i.e., maintainable in the long term) and to ensure that +the team has a shared understanding of the package's scope and +architecture before starting the development. `check-datapackage`'s design builds off of our overall Seedcase [design principles and patterns](https://design.seedcase-project.org/), and -strongly follows the -same design principles and patterns described there. +strongly follows the same design principles and patterns described +there. ## Purpose @@ -30,16 +31,18 @@ Specifically, `check-datapackage` should: Overall, `check-datapackage` must: -- Check Data Package descriptors against the Data Package standard, specifically the Data Package [profiles](https://datapackage.org/standard/glossary/#profile). +- Check Data Package descriptors against the Data Package standard, + specifically the Data Package + [profiles](https://datapackage.org/standard/glossary/#profile). - Allow configuration to check or not check certain components of the descriptor. - Support turning off specific checks defined in the standard. - Support custom, user-defined checks in addition to those in the standard. -- Provide clear, user-friendly, and structured messages about - any issues, identifying where in the descriptor the issues occur. -- Provide a strict mode that enforces all aspects of the Data - Package standard, including all recommendations. +- Provide clear, user-friendly, and structured messages about any + issues, identifying where in the descriptor the issues occur. +- Provide a strict mode that enforces all aspects of the Data Package + standard, including all recommendations. - Be designed in a way that can be extended as a command-line interface (CLI) in the future. From 0a325ed320fc92fdbeda107200c0ad27fae3a373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 26 Sep 2025 13:32:41 +0200 Subject: [PATCH 3/4] docs: :fire: remove "correctness" from overall aim "correctness" can mean "being in agreement with the true facts" (according to Cambridge dict) which is outside of the scope of this package; we don't ensure that what is in the descriptor is actually correct or true. According to Merriam-Webster, "correctbess" can mean "conforming to an approved or conventional standard" and with this definition its basically the same as "compliance". So, it's either not entirely what we want with this package or very similar to compliance, so I'll remove it here. --- docs/design/index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/index.qmd b/docs/design/index.qmd index ea0e99c..bdab6b9 100644 --- a/docs/design/index.qmd +++ b/docs/design/index.qmd @@ -15,7 +15,7 @@ there. ## Purpose -The overall aim of `check-datapackage` is to check the correctness and +The overall aim of `check-datapackage` is to check the compliance of [Data Package descriptors](https://datapackage.org/standard/glossary/#descriptor) (i.e., the contents of `datapackage.json`) against the [Data Package From 0d53c1120f01d119aa553305a8260d3fe3423389 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Fri, 26 Sep 2025 13:33:41 +0200 Subject: [PATCH 4/4] style: :art: format `qmd` --- docs/design/index.qmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/design/index.qmd b/docs/design/index.qmd index bdab6b9..faf5a76 100644 --- a/docs/design/index.qmd +++ b/docs/design/index.qmd @@ -15,8 +15,8 @@ there. ## Purpose -The overall aim of `check-datapackage` is to check the -compliance of [Data Package +The overall aim of `check-datapackage` is to check the compliance of +[Data Package descriptors](https://datapackage.org/standard/glossary/#descriptor) (i.e., the contents of `datapackage.json`) against the [Data Package standard](https://datapackage.org/).