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

feat: make DatasetVersion repr valid Julia code #84

Merged
merged 6 commits into from
Mar 11, 2025

Conversation

mortenpi
Copy link
Member

@mortenpi mortenpi commented Mar 11, 2025

This makes sure that the short DatasetVersion string representation is a valid Julia code:

julia> dataset.versions
2-element Vector{JuliaHub.DatasetVersion}:
 JuliaHub.dataset(("username", "example-dataset")).versions[1]
 JuliaHub.dataset(("username", "example-dataset")).versions[2]

Also fix a doctest in the DatasetVersion docstring, which now in turn exercises the show methods for DatasetVersion. Also, add a fix-doctests Make command.

@mortenpi mortenpi added the documentation Improvements or additions to documentation label Mar 11, 2025
@mortenpi mortenpi requested a review from a team March 11, 2025 05:58
@mortenpi mortenpi changed the title docs: fix doctest in DatasetVersion docstring feat: make DatasetVersion repr valid Julia code Mar 11, 2025
@mortenpi mortenpi added the enhancement New feature or request label Mar 11, 2025
@mortenpi mortenpi enabled auto-merge (squash) March 11, 2025 08:01
pfitzseb
pfitzseb previously approved these changes Mar 11, 2025
@mortenpi mortenpi merged commit b2558f8 into main Mar 11, 2025
13 checks passed
@mortenpi mortenpi deleted the mp/fix-datasetversion-docstring branch March 11, 2025 21:48
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants