Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@juliohm
juliohm committed Jan 8, 2025
1 parent d97a499 commit 3b6f255
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@ CDSAPI.py2ju("""
We've copied/pasted the code and called the `py2ju` function on the second argument of the `retrieve` function.
The `py2ju` function simply converts the string containing a Python dictionary to an actual Julia dictionary.

Besides the downloaded file, the `retrieve` function also returns a dictionary with the following entries:
Besides the downloaded file, the `retrieve` function also returns a dictionary with metadata:

```
Dict{String,Any} with 6 entries:
"result_provided_by" => "8a3eb001-c8e3-4a9c-8170-28191ebea14b"
Expand Down

2 comments on commit 3b6f255

@juliohm
Copy link
Member Author

@juliohm juliohm commented on 3b6f255 Jan 8, 2025

Choose a reason for hiding this comment

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

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/122596

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v2.0.1 -m "<description of version>" 3b6f255e8aa87f5c9e8875201a82fdade7f4f986
git push origin v2.0.1

Please sign in to comment.