Skip to content

Brings JPEG2000 endpoints to Facade#36

Merged
dgarciabriseno merged 60 commits intoHelioviewer-Project:mainfrom
akash5100:jpeg2000_endpoints
Jul 13, 2022
Merged

Brings JPEG2000 endpoints to Facade#36
dgarciabriseno merged 60 commits intoHelioviewer-Project:mainfrom
akash5100:jpeg2000_endpoints

Conversation

@akash5100
Copy link
Collaborator

@akash5100 akash5100 commented Jul 11, 2022

@nabobalis
Copy link
Member

For future reference, you will want to add Fixes to the issue number otherwise the issue won't close on merge and you will want to figure out how to update your branch without having to do a merge commit.

@nabobalis
Copy link
Member

Looks like the docstrings will need some future changes to get the CI to be happy with it. Have to keep running them locally and changing them to get them to pass.

@akash5100
Copy link
Collaborator Author

For future reference, you will want to add Fixes to the issue number otherwise the issue won't close on merge and you will want to figure out how to update your branch without having to do a merge commit.

The issue number is already linked to this PR.

Co-authored-by: Nabil Freij <nabil.freij@gmail.com>
@nabobalis
Copy link
Member

For future reference, you will want to add Fixes to the issue number otherwise the issue won't close on merge and you will want to figure out how to update your branch without having to do a merge commit.

The issue number is already linked to this PR.

Oh they have changed that, that never used to work like that.

@codecov-commenter
Copy link

codecov-commenter commented Jul 12, 2022

Codecov Report

Merging #36 (8b8d069) into main (882c741) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #36   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          133       153   +20     
=========================================
+ Hits           133       153   +20     
Impacted Files Coverage Δ
hvpy/api_groups/jpeg2000/get_jp2_header.py 100.00% <ø> (ø)
hvpy/api_groups/jpeg2000/get_jp2_image.py 100.00% <ø> (ø)
hvpy/api_groups/jpeg2000/get_jpx.py 100.00% <ø> (ø)
...pi_groups/jpeg2000/get_jpx_closest_to_mid_point.py 100.00% <ø> (ø)
hvpy/api_groups/jpeg2000/get_status.py 100.00% <ø> (ø)
hvpy/facade.py 100.00% <100.00%> (ø)
hvpy/parameters.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 882c741...8b8d069. Read the comment docs.

@nabobalis
Copy link
Member

/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPX:17: WARNING: duplicate object description of hvpy.sourceId, other instance in api/hvpy.getJP2Image, use :noindex: for one of them
/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPX:35: WARNING: duplicate object description of hvpy.jpip, other instance in api/hvpy.getJP2Image, use :noindex: for one of them
/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPXClosestToMidPoint:17: WARNING: duplicate object description of hvpy.sourceId, other instance in api/hvpy.getJPX, use :noindex: for one of them
/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPXClosestToMidPoint:23: WARNING: duplicate object description of hvpy.linked, other instance in api/hvpy.getJPX, use :noindex: for one of them
/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPXClosestToMidPoint:29: WARNING: duplicate object description of hvpy.verbose, other instance in api/hvpy.getJPX, use :noindex: for one of them
/home/runner/work/python-api/python-api/.tox/build_docs/lib/python3.10/site-packages/hvpy/facade.py:docstring of hvpy.facade.getJPXClosestToMidPoint:35: WARNING: duplicate object description of hvpy.jpip, other instance in api/hvpy.getJPX, use :noindex: for one of them

Looks like we will need to work out how to fix this.

@akash5100
Copy link
Collaborator Author

Looks like we will need to work out how to fix this.

I am not sure how to use :noindex:

@nabobalis
Copy link
Member

nabobalis commented Jul 13, 2022

You will need to change the docs to look like this: https://github.com/Helioviewer-Project/python-api/pull/37/files That will fix the error.

@dgarciabriseno dgarciabriseno merged commit a5eaac4 into Helioviewer-Project:main Jul 13, 2022
@akash5100 akash5100 deleted the jpeg2000_endpoints branch July 13, 2022 16:06
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.

Create facade for jpeg2000 endpoints.

4 participants

Comments