Skip to content

Added documentation for datasets#280

Merged
jesper-friis merged 58 commits intomasterfrom
dataset-docs
Jan 3, 2025
Merged

Added documentation for datasets#280
jesper-friis merged 58 commits intomasterfrom
dataset-docs

Conversation

@jesper-friis
Copy link
Contributor

@jesper-friis jesper-friis commented Jan 2, 2025

Description

Added documentation for datasets. Other changes:

  • added utils.openfile() and replaced open() with utils.openfile() in TableDoc.parse_csv()
  • import backends in tripper.__init__.py to avoid pytest failing with RuntimeError: dictionary changed size during iteration when collecting tripper.__init__.py.
  • several other minor changes added while debugging the above issue

The documentation can be checked locally with:

pip install -U -e .[docs]
mkdocs serve
# Open http://127.0.0.1:8000/tripper/ in your browser

Builds on top of PR #279

Type of change

  • Bug fix and code cleanup
  • New feature
  • Documentation update
  • Testing

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

  • Is the change limited to one issue?
  • Does this PR close the issue?
  • Is the code easy to read and understand?
  • Do all new feature have an accompanying new test?
  • Has the documentation been updated as necessary?
  • Is the code properly tested?

jesper-friis and others added 30 commits December 15, 2024 19:18
  - Allow to add other types of entries to the triplestore that are not
    datasets. Ex: samples, models, instruments, people, projects...
  - Renamed list_data_iris() to search_iris(). It can now be use to search
    for all types of entries.
  - Renamed prepare() to as_jsonld() and made it part of the public API
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
@codecov
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

Attention: Patch coverage is 97.77778% with 1 line in your changes missing coverage. Please review.

Project coverage is 79.18%. Comparing base (6101c87) to head (e054557).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
tripper/utils.py 96.29% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #280      +/-   ##
==========================================
+ Coverage   78.69%   79.18%   +0.49%     
==========================================
  Files          21       21              
  Lines        2229     2263      +34     
==========================================
+ Hits         1754     1792      +38     
+ Misses        475      471       -4     

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

@jesper-friis jesper-friis requested a review from torhaugl January 2, 2025 14:36
@jesper-friis jesper-friis mentioned this pull request Jan 3, 2025
24 tasks
Copy link
Contributor

@torhaugl torhaugl left a comment

Choose a reason for hiding this comment

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

Mostly improved documentation. I think a link to JSON-LD playground would be nice in the customization part. I'll let you decide if you want to commit these changes before merging.

I did not read all the descriptions for the pre-defined keywords in detail, but a quick glance and they look reasonable. Includes a new function openfile (to open over http) and corresponding test.

Base automatically changed from dataset-todos to master January 3, 2025 22:38
@jesper-friis jesper-friis enabled auto-merge (squash) January 3, 2025 23:08
@jesper-friis jesper-friis merged commit 6991b2a into master Jan 3, 2025
18 of 19 checks passed
@jesper-friis jesper-friis deleted the dataset-docs branch January 3, 2025 23:09
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.

2 participants