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

Data descriptions #1122

Merged
merged 10 commits into from
Feb 10, 2025
Merged

Data descriptions #1122

merged 10 commits into from
Feb 10, 2025

Conversation

forman
Copy link
Member

@forman forman commented Feb 6, 2025

This PR requires xcube-dev/xcube-viewer#466 for review.

xcube Server now can be configured to provide abstracts/descriptions for datasets so they can be rendered as markdown in xcube Viewer (xcube-dev/xcube-viewer#454).

  1. New description properties have been added to responses from xcube Server for datasets and variables.
  2. User can now provide abstracts or descriptions using markdown format for dataset configurations in xcube Server. A new configuration setting Description now accompanies settings such as Title.
  3. Default values for the Description setting are derived from metadata of datasets and variable CF attributes.

Closes #1121

Checklist:

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/source/*
  • Changes documented in CHANGES.md
  • GitHub CI passes
  • AppVeyor CI passes
  • Test coverage remains or increases (target 100%)

@forman forman self-assigned this Feb 6, 2025
@forman forman changed the title Dataset descriptions Data descriptions Feb 9, 2025
Copy link

codecov bot commented Feb 9, 2025

Codecov Report

Attention: Patch coverage is 95.00000% with 3 lines in your changes missing coverage. Please review.

Project coverage is 89.32%. Comparing base (a2199cc) to head (44ec1d9).
Report is 11 commits behind head on main.

Files with missing lines Patch % Lines
xcube/webapi/datasets/controllers.py 94.87% 2 Missing ⚠️
xcube/webapi/datasets/context.py 87.50% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1122   +/-   ##
=======================================
  Coverage   89.32%   89.32%           
=======================================
  Files         277      277           
  Lines       21293    21319   +26     
=======================================
+ Hits        19020    19044   +24     
- Misses       2273     2275    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@forman forman requested a review from TonioF February 10, 2025 10:49
@forman forman marked this pull request as ready for review February 10, 2025 10:49
Copy link
Contributor

@TonioF TonioF left a comment

Choose a reason for hiding this comment

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

Just one minor comment. Also, I did not see any changes in the viewer. I was just reviewing the server setup, though, and everything looks good.

Comment on lines +183 to +184
def setUp(self):
self.maxDiff = None
Copy link
Contributor

Choose a reason for hiding this comment

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

If you set it here, you can remove it at the starts of tests.

Copy link
Member Author

Choose a reason for hiding this comment

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

Right.

@forman
Copy link
Member Author

forman commented Feb 10, 2025

Also, I did not see any changes in the viewer. I was just reviewing the server setup, though,

You need to checkout the corresponding branch. Viewer changes are notyet bundled.

@forman forman merged commit b2e8d2c into main Feb 10, 2025
5 checks passed
@forman forman deleted the forman-1121-dataset_descriptions branch February 10, 2025 11:58
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.

xcube Server to provide dataset and variable markdown descriptions
2 participants