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

Docs/data sources #1039

Merged
merged 11 commits into from
Sep 6, 2024
Merged

Docs/data sources #1039

merged 11 commits into from
Sep 6, 2024

Conversation

Jaapel
Copy link
Contributor

@Jaapel Jaapel commented Sep 5, 2024

Issue addressed

Fixes part of the documentation

Explanation

  • Introduced doctest to the data types documentation.
  • Updated options to be a property of the URIResolver instead of passing this at runtime. This allows for specifying certain resolver-specific options in the data catalog.
  • Fixed a bug where Dataset was not a known data type. Apparently this was never tested, which is concerning.
  • Updated some (quite outdated, even on v0) docstrings in the DataCatalog methods.

@Jaapel Jaapel self-assigned this Sep 5, 2024
@Jaapel Jaapel added the V1 label Sep 5, 2024
@Jaapel Jaapel requested a review from savente93 September 5, 2024 14:06
@Jaapel Jaapel added the Documentation Improvements or additions to documentation label Sep 5, 2024
@Jaapel Jaapel added this to the v1.0 beta milestone Sep 5, 2024
Copy link
Contributor

@savente93 savente93 left a comment

Choose a reason for hiding this comment

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

LGMT

Copy link
Contributor

@savente93 savente93 left a comment

Choose a reason for hiding this comment

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

looks good but tests should be fixed first

Copy link
Contributor

@savente93 savente93 left a comment

Choose a reason for hiding this comment

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

All good now

@Jaapel Jaapel merged commit 6813f06 into v1 Sep 6, 2024
8 checks passed
@Jaapel Jaapel deleted the docs/data_sources branch September 6, 2024 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation V1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants