Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR to refine the message about dataset series' member (issue 1429) #1458

Merged
merged 18 commits into from
Mar 8, 2022

Conversation

riccardoAlbertoni
Copy link
Contributor

@riccardoAlbertoni riccardoAlbertoni commented Feb 22, 2022

This PR is a work in progress attempt aiming at sharpen the message about dataset series members.

Rendered at: http://raw.githack.com/w3c/dxwg/dcat-issue-1429/dcat/index.html

Diff at: https://services.w3.org/htmldiff?doc1=https%3A%2F%2Fw3c.github.io%2Fdxwg%2Fdcat&doc2=https%3A%2F%2Fraw.githack.com%2Fw3c%2Fdxwg%2Fdcat-issue-1429%2Fdcat%2F

This when merged is expected to close #1429.

dcat/index.html Outdated
@@ -2495,7 +2495,7 @@ <h4>Property: in series</h4>
<!--tr><th class="prop">Inverse property of:</th>
<td><a href="#Property:dataset_series_series_member"><code>dcat:seriesMember</code></a></td>
</tr-->
<tr><th class="prop">Usage note:</th><td> Normally, child datasets in dataset series are represented as <code>dcat:Dataset</code>. The use of <code>dcat:Distribution</code> for typing child datasets is however recognized as a possible alternative, whenever it addresses more effectively the requirements of a given application scenario.</td></tr>
<tr><th class="prop">Usage note:</th><td> Child datasets in dataset series SHOULD be represented as <code>dcat:Dataset</code>.<!--The use of <code>dcat:Distribution</code> for typing child datasets is however recognized as a possible alternative, whenever it addresses more effectively the requirements of a given application scenario.--></td></tr>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is quite a strong change. It is clearly justified in principle. However, it may not be sustainable in practice. DCAT does not have wide adoption already. Maybe it is more influential than adopted.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is quite a strong change.

It might be not that strong. We are using "SHOULD", not "MUST".

"SHOULD" means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.

The change attempts to clarify that using datasets as members in series is the recommended solution.
Other solutions are possible, but this is the one DCAT 3 considers the most flexible and versatile and the one recommended for the new implementations.

Existing or even future implementations can do otherwise if they have thoroughly considered the consequences.

We don't want to alienate the existing implementations. Therefore, we explained that current solutions are not incompatible with DCAT 3 during the upgrade to DCAT 3 (see the non-normative section beginning at line 5128).

However, unless we want to support more than a solution and thus accept interoperability issues intrinsic in the availability of more than one recommended solution, we need to be clear on the recommended approach.
I am not 100% sure this is the best way to do it.

Do you think a "MAY" instead of "SHOULD" would be more appropriate? Do you have any suggestions on how to convey the message more appropriately?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Riccardo. I'm OK with the proposal. Was just checking, and I note the use of SHOULD.

@riccardoAlbertoni
Copy link
Contributor Author

Though I guess there will be further discussion and request of adjustments for this PR, I am marking this as ready for review to solicit opinions ;)

@riccardoAlbertoni riccardoAlbertoni marked this pull request as ready for review February 24, 2022 20:01
dcat/index.html Outdated Show resolved Hide resolved
dcat/index.html Outdated Show resolved Hide resolved
@riccardoAlbertoni
Copy link
Contributor Author

@andrea-perego, please double-check if I have implemented your suggestion correctly via 62945d9,

dcat/index.html Outdated Show resolved Hide resolved
dcat/index.html Outdated Show resolved Hide resolved
dcat/index.html Outdated Show resolved Hide resolved
Copy link
Contributor

@andrea-perego andrea-perego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have added a number of inline change proposals.

Basically, the idea is to put the links to the section on dataset series as done for the versioning properties, and not in the "See also" row of class/property definitions.

DCAT Sprint: Dataset Series automation moved this from In progress to Review in progress Mar 1, 2022
riccardoAlbertoni and others added 5 commits March 2, 2022 12:24
Co-authored-by: Andrea Perego <andrea-perego@users.noreply.github.com>
Co-authored-by: Andrea Perego <andrea-perego@users.noreply.github.com>
Co-authored-by: Andrea Perego <andrea-perego@users.noreply.github.com>
Co-authored-by: Andrea Perego <andrea-perego@users.noreply.github.com>
dcat/index.html Outdated Show resolved Hide resolved
dcat/index.html Outdated Show resolved Hide resolved
dcat/index.html Outdated Show resolved Hide resolved
@riccardoAlbertoni riccardoAlbertoni changed the title PR issue 1429 PR to refine the message about dataset series' member (issue 1429) Mar 4, 2022
andrea-perego and others added 3 commits March 6, 2022 21:15
Co-authored-by: Riccardo Albertoni <albertoni@ge.imati.cnr.it>
Co-authored-by: Riccardo Albertoni <albertoni@ge.imati.cnr.it>
DCAT Sprint: Dataset Series automation moved this from Review in progress to Reviewer approved Mar 7, 2022
@dr-shorthair dr-shorthair merged commit 9433df7 into gh-pages Mar 8, 2022
DCAT Sprint: Dataset Series automation moved this from Reviewer approved to Done Mar 8, 2022
@dr-shorthair dr-shorthair deleted the dcat-issue-1429 branch March 8, 2022 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Model Series of Data as Distributions of a single Dataset
3 participants