Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
john-b-edwards authored Sep 22, 2024
1 parent f2715d4 commit 3c24f5e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ discord](https://img.shields.io/discord/789805604076126219?color=7289da&label=nf

`NFLData.jl` is a low level package designed to read football data from the [nflverse](https://nflverse.nflverse.com/) into Julia in a `DataFrame` format. This package can be thought of as the Julia equivalent of the `{nflreadr}` R package. Functions are named identically to existing functions in `{nflreadr}`, (typically) take the same arguments, and should return identical data. This package is built by and mantained by the nflverse organization, primarily [@john-b-edwards](https://github.com/john-b-edwards).

The below is an introductory glimpse to `NFLData.jl`. Largely complete NFLData.jl docs can be found [here](https://nflverse.github.io/NFLData.jl/stable/), and all of the data resources available are documented [here](https://nflreadr.nflverse.com/).
The below is an introductory glimpse to `NFLData.jl`. Largely complete `NFLData.jl` docs can be found [here](https://nflverse.github.io/NFLData.jl/stable/), and all of the data resources available are documented [here](https://nflreadr.nflverse.com/).

In the event that you encounter a bug or unexpected error, please [make an issue](https://github.com/nflverse/NFLData.jl/issues/new/choose) and we will attempt to address it.

Expand Down

6 comments on commit 3c24f5e

@john-b-edwards
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Error while trying to register: "Tag with name v1.1.2 already exists and points to a different commit"

@john-b-edwards
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Error while trying to register: "Tag with name v1.1.2 already exists and points to a different commit"

@john-b-edwards
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@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/115711

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 v1.1.2 -m "<description of version>" 3c24f5ee5a5587a75eafaddb2fa23a10bac1c35c
git push origin v1.1.2

Also, note the warning: Version 1.1.2 skips over 1.1.0
This can be safely ignored. However, if you want to fix this you can do so. Call register() again after making the fix. This will update the Pull request.

Please sign in to comment.