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

Esa gaia gaiapcr 1290 include the new data link linking parameter #2859

Conversation

cosmoJFH
Copy link

Hi, my name is Jorge Fdez, and I work as a software developer at ESAC (gaia mission). The new parameter linking_parameter can be used in the datalink service, in order to provide an additional meaning to the source identifiers: source_id, transit_id and image_id. This parameter is optional, in order to be backward compatible, and therefore, if the parameter is not set, the source identifiers are considered as source_id,

These changes are related to the jira ticket https://s2e2.cosmos.esa.int/jira/browse/GAIAPCR-1290.

@esdc-esac-esa-int

@pep8speaks
Copy link

pep8speaks commented Oct 20, 2023

Hello @cosmoJFH! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2023-11-07 04:20:05 UTC

@cosmoJFH
Copy link
Author

cosmoJFH commented Oct 20, 2023

There exist a failing test that is not part of this PR

image

Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Thank you for the PR @cosmoJFH.

I left a couple of inline comments. Besides those, it would be great not to include any reformatting changes, like the line wraps in unrelated PRs. Now it's just adds a couple 10s of extra diff, but in bigger PRs it can be rather distruptive.

Do get this merged, would you consider showing the usage in the narrative docs? Either by adding a new example, or modifying one of the existing ones.

Also, having a non monkeypatched test would be useful, so we actually test that the code works with the server, as expected.

Comment on lines 238 to 239
output_file = os.path.join(os.getcwd(), temp_dirname,
downloadname_formated)
Copy link
Member

Choose a reason for hiding this comment

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

We do let longer lines in astroquery (max-line-length = 120). It is supposed to be picked up from the config files, but I'm happy to add new sections that your editor/IDE would respect.

Copy link
Author

Choose a reason for hiding this comment

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

Sorry for the mistake, I misconfigured my pycharm IDE: I set the max line length to 79 characters. I have reverted the formatting changes

Comment on lines +200 to +201
By default, all the identifiers are considered as source_id
SOURCE_ID: the identifiers are considered as source_id
Copy link
Member

Choose a reason for hiding this comment

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

Why to have SOURCE_ID as the default then, instead of None?

Copy link
Author

Choose a reason for hiding this comment

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

Yes, you are right it is more convenient to set the default value to SOURCE_ID

@cosmoJFH
Copy link
Author

cosmoJFH commented Oct 21, 2023

We have included a new section to the gaia documentation, devoted to the datalink service. Note that it does not include any reference to the new parameter linking_parameter, since this information must be included in the gaia help (https://www.cosmos.esa.int/web/gaia-users/archive) beforehand by the gaia team as ESAC.

@bsipocz bsipocz added this to the v0.4.7 milestone Nov 3, 2023
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Some suggestions of wordsmithing and cleanups in the docs, otherwise this is good to go.

@cosmoJFH - if you're happy with the suggestions, just give me the go-ahead, and I can commit the changes along with fixes to the docs build and merge.

docs/gaia/gaia.rst Outdated Show resolved Hide resolved
docs/gaia/gaia.rst Outdated Show resolved Hide resolved
docs/gaia/gaia.rst Outdated Show resolved Hide resolved
@cosmoJFH
Copy link
Author

cosmoJFH commented Nov 3, 2023

Hi @bsipocz we are happy with the changes you suggested for the documentation.

Copy link

codecov bot commented Nov 7, 2023

Codecov Report

Merging #2859 (8e4142d) into main (37758c1) will increase coverage by 0.00%.
Report is 22 commits behind head on main.
The diff coverage is 83.33%.

@@           Coverage Diff           @@
##             main    #2859   +/-   ##
=======================================
  Coverage   66.51%   66.52%           
=======================================
  Files         235      235           
  Lines       18096    18101    +5     
=======================================
+ Hits        12037    12041    +4     
- Misses       6059     6060    +1     
Files Coverage Δ
astroquery/gaia/core.py 71.97% <83.33%> (+0.14%) ⬆️

... and 3 files with indirect coverage changes

📣 Codecov offers a browser extension for seamless coverage viewing on GitHub. Try it in Chrome or Firefox today!

@bsipocz bsipocz force-pushed the ESA_gaia_GAIAPCR-1290_Include_the_new_DataLink_linking_parameter branch from f7bcd11 to 99a9b8a Compare November 7, 2023 03:43
@bsipocz bsipocz force-pushed the ESA_gaia_GAIAPCR-1290_Include_the_new_DataLink_linking_parameter branch from 99a9b8a to 8e4142d Compare November 7, 2023 04:19
@bsipocz bsipocz merged commit 24aa587 into astropy:main Nov 7, 2023
10 checks passed
@bsipocz
Copy link
Member

bsipocz commented Nov 7, 2023

Thank you @cosmoJFH!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants