Skip to content

Pen review#10

Open
gilleslandais wants to merge 12 commits intomainfrom
pen-review
Open

Pen review#10
gilleslandais wants to merge 12 commits intomainfrom
pen-review

Conversation

@gilleslandais
Copy link
Copy Markdown
Collaborator

No description provided.

@gilleslandais gilleslandais requested a review from msdemlei April 14, 2026 17:17
Copy link
Copy Markdown
Collaborator

@msdemlei msdemlei left a comment

Choose a reason for hiding this comment

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

I've not looked at the scripts in tests (should I?). For the rest, I have a couple of comments and suggestions. Feel free to ignore what you disagree with...

Comment thread data-origin.tex

The IVOA Registry uses a unique identifier, the IVOID
\citep{2016ivoa.spec.0523D}, as the primary key for its resource
collection. By the above considerations, this IVOID is not suitable as a means of citation.%, because it is a technical identifier with no provisions for persistence today. remove 2025-11-03
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Avoid commenting out stuff like this in version-controlled documents; you can always pull back stuff from the history if necessary. Anyway: you intended for this to be gone last november :-)

Comment thread data-origin.tex
get the main entity from a resource that is the data of origin, typically in one step
(an entity generated by an activity that used another entity as origin).

This mapping is illustrate in a VO Provenance Model \citep{2020ivoa.spec.0411S} in appendix
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Again, I would prefer deletions to commenting out, but sentence looks very much incomplete even after eliminating the comments. It "this mapping is illustrated..."?

Comment thread data-origin.tex
\caption{\xmlel{INFO} names available for specifying the query that
generated a VOTable}
%\caption{\xmlel{INFO} names available for specifying the query that generated a VOTable}
\caption{\xmlel{INFO} names for specifying the query that generated a VOTable} % shorter to let place to put the table2
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This comment is a bit mystifying. Do you mean "leave space"? But you comment about this?

Comment thread data-origin.tex
resource\_version & Dataset version & \\ \hline
%rename 23-nov-2023 rights & (*) Licence URI & R & rights\\ \hline
rights\_uri & Licence URI (*) & rights\\ \hline
% removed 23-nov-2023 rights\_type & (*) Licence type (eg: CC-by, CC-0, private, public) & & \\ \hline
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Another mystifying comment: What is it that was removed? And why should there be a comment about it?

Comment thread data-origin.tex
originating resource & relation\\ \hline
is\_derived\_from & An Identifier (ivoid, DOI, bibcode) of a resource
being in an ``is\_derived\_from'' (**) relationship
to the originating resourcd & relation\\ \hline
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/resourcd/resource/. But frankly, I'd like it better if we spelled out what "is_derived_from" means: "if the originating resource was produced using data from the reference resource" or so.

Comment thread data-origin.tex
It is expressly allowed to supply data origin in individual
\xmlel{TABLE} or \xmlel{RESOURCE} elements in more complex VOTables.

For best practice, the global items listed in Table \ref{tab:query-names} should be placed directly at the root of the VOTable document. If a VOTable document contains several resources or tables, the items listed in Table \ref{tab:origin-names} can be placed in their respective resources or tables.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'd write "As a best practice".

Comment thread data-origin.tex
\paragraph{}
\begin{tabular}{|p{2.8cm}|p{3cm}|p{3cm}|p{4cm}|} \hline
\multicolumn{4}{|l|}{\textbf{content} } \\ \hline
source & article & RelatedIdentifier (*) & The Reference article (bibcode or DOI)\\ \hline
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'd prefer "A scholarly publication to cite when the data is used".

Comment thread data-origin.tex
\\ \hline
URI & rights\_uri& rightsURI & The License URL\\ \hline
% & & rightsIdentifier & The Standard license name .ex CC-by.
% Copyright is accepted by FAIR principle. But copyright is only a link to the data producer. It gives the contact point to any users who would like to use data. Copyright is more simple to implement for data-centre that provides a copy of original resource, but its use is not well integrated in an interoperable workflow.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Uh... that's a lot of text that is only loosely related to rights_uri. Copyright is, that's right, the basis of licensing, but that's it. right_uri, on the other hand, is a simple URI to a license. We don't say who is the licensor, which is something of a problem. In that sense, we should just say: "A machine-readable identifier for the usage and distribution conditions; within the VO, use SPDX URIs".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants