Skip to content

Update gaia.rst with corrected hyperlinks#2987

Merged
bsipocz merged 2 commits into
astropy:mainfrom
hectorcanovas:patch-1
Apr 9, 2024
Merged

Update gaia.rst with corrected hyperlinks#2987
bsipocz merged 2 commits into
astropy:mainfrom
hectorcanovas:patch-1

Conversation

@hectorcanovas

Copy link
Copy Markdown
Contributor

Dear Astropy/Astroquery team.

This is Héctor Cánovas, Support Archive Scientist of the Gaia ESA Archive (writing from my personal account). While inspecting the recently updated documentation of Astroquery.Gaia I noticed that there are 8 hyperlinks that miss the colon (:) symbol after the "https" preamble, and hence they do not work. This proposed version has updated these links as: https// >> https://

Dear Astropy/Astroquery team.

This is Héctor Cánovas, Support Archive Scientist of the Gaia ESA Archive (writing from my personal account). While inspecting the recently updated documentation of Astroquery.Gaia I noticed that there are 8 hyperlinks that miss the colon (:) symbol after the "https" preamble, and hence they do not work. This proposed version has updated these links as: https// >> https://

@bsipocz bsipocz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for fixing the urls, I'm afraid we don't have a good mechanism to fix these in a more automated way.

However the exact changes cause the docs build to fail, so some fixes are needed before this can be merged.

Comment thread docs/gaia/gaia.rst
International Virtual Observatory Alliance (IVOA_).

.. _IVOA: https//www.ivoa.net
.. _TAP: https://www.ivoa.net/documents/TAP/

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

There are multiple TAP references (even in this same filee, but there maybe one already in the other docs files) so adding these breaks the docs build. Please either reuse the exising reference or use one-off links as before (albeit without the typo of course)

@hectorcanovas

Copy link
Copy Markdown
Contributor Author

Thanks a lot for your help - now I am confused about how to proceed: should I create a new pull request from the Astroquery.Gaia documentation (https://astroquery.readthedocs.io/en/latest/gaia/gaia.html)? - this is how I created this pull request?

The duplicated _TAP link has been deleted, and I have verified that there are no duplicated links in the text.
@bsipocz

bsipocz commented Apr 9, 2024

Copy link
Copy Markdown
Member

Thanks a lot for your help - now I am confused about how to proceed: should I create a new pull request from the Astroquery.Gaia documentation (https://astroquery.readthedocs.io/en/latest/gaia/gaia.html)? - this is how I created this pull request?

No, please keep working on in this PR rather than opening another.

We follow the typical fork based PR workflow wheere you have a local clone of the repo and edit files directly.
https://docs.astropy.org/en/latest/development/workflow/development_workflow.html

If you have edited it directly on github, you can still keep doing that, but in the long term that is much more limited and clumpsy (e.g. no way to run the tests locally, or make logical code chuncks into commits, etc.), but here it could still work:

Go to "Files changed", then choose "Edit" the file from the kebab menu.

Uploading Screen Shot 2024-04-09 at 13.33.57.png…

@bsipocz bsipocz left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

RTD is passing now, so merging the PR.

Thanks @hectorcanovas and congrats on your first PR to astroquery!

@bsipocz bsipocz merged commit fe60dc4 into astropy:main Apr 9, 2024
@hectorcanovas hectorcanovas deleted the patch-1 branch April 9, 2024 20:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants