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

Change of name #17

Merged
merged 17 commits into from
Dec 18, 2024
Merged

Change of name #17

merged 17 commits into from
Dec 18, 2024

Conversation

jesusjuansalgado
Copy link
Collaborator

No description provided.

@jesusjuansalgado jesusjuansalgado requested review from gmantele and a team November 18, 2024 17:51
Copy link
Contributor

@gmantele gmantele 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 applied few changes (README, CI, SVG, ...) that were only in my PR #15 , but not here.

However, I have noticed few things that bother me. Can you, @jesusjuansalgado and Aitor comment about them (or fix them directly in the document, if needed)?

@@ -256,7 +255,7 @@ \subsection{\{query\} resource} \label{sec:query}
names refer to those defined in the ObsCore Data Model .

Some of the parameters proposed in this standard are not described in
the ObsCore Data Model document , such as; min\_vis, max\_vis,
the ObsCore Data Model document , such as; min\_obs, max\_obs,
Copy link
Contributor

Choose a reason for hiding this comment

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

There should probably be a mention about the fact that the name of these columns has changed since the last version of this document. So, it probably worth to mention in the Change Log.

called \textbf{VIS\_MIN}. This parameter would constrain the visibility
check to those time periods with at least the minimum visibility specified
in the parameter. The unit of \textbf{VIS\_MIN} parameters must be expressed
\item{\textbf{MIN\_OBS}\\A service \textbf{MAY} have a search parameter
Copy link
Contributor

Choose a reason for hiding this comment

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

min_obs seems to be the new name for two columns in the former version: min_viz (l.259 in old version) and viz_min (l.358 in old version). Is it normal?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, it is correct.
We wanted to clarify that we are no longer using the term visibility in any part of the document. That’s why we changed vis_min to min_obs.


\item {Exactly one field \textbf{MUST} have a name="\textbf{t\_visibility}"
\item {Exactly one field \textbf{MUST} have a name="\textbf{t\_observability}"
Copy link
Contributor

Choose a reason for hiding this comment

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

This column name change should also be mentioned in the Change Log.

I guess the existing ObjVisSAP/ObjObsSAP service(s) MUST be updated too, isn't it?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes.

Copy link
Collaborator

Choose a reason for hiding this comment

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

added to the Change log

@@ -256,7 +255,7 @@ \subsection{\{query\} resource} \label{sec:query}
names refer to those defined in the ObsCore Data Model .

Some of the parameters proposed in this standard are not described in
the ObsCore Data Model document , such as; min\_vis, max\_vis,
the ObsCore Data Model document , such as; min\_obs, max\_obs,
Copy link
Contributor

Choose a reason for hiding this comment

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

max_obs is mentioned here, but is never described in this document, on the contrary to min_obs.
Is it normal?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks Gregory, I think all the points mentioned are relevant. I would let Aitor to edit directly the doc (I said to him that if he has some problem pushing from command line, small changes could be done directly in the portal). In case he still face problem pushing changes to this pull request, I could suppport

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for having check these so quickly.

About Aitor, his invite to join this repo has expired. That's why he was not able to push anything. I've sent a new invite. I hope it will solve his issue.

Copy link
Collaborator

Choose a reason for hiding this comment

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

If I remember correctly, we discussed time ago about to add max_obs as input. But then we decided to move it an optional output parameter.
I have added the description in the "Standard output fields" section.

max_obs description added to the optional output parameters.
Change log section added
Copy link
Contributor

@gmantele gmantele left a comment

Choose a reason for hiding this comment

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

Seems OK to me now.
Feel free to merge whenever you want.

@aibaiba aibaiba merged commit 797da77 into master Dec 18, 2024
1 check passed
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.

3 participants