Skip to content

Commit

Permalink
clear up use of @stable
Browse files Browse the repository at this point in the history
  • Loading branch information
@MilesCranmer
MilesCranmer committed May 28, 2024
1 parent 073023a commit 9cc1040
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Instability errors are also skipped during precompilation.

> [!NOTE]
> `@stable` will have no effect on code if it is:
> - Within an unsupported Julia version
> - Within an `@unstable` block
> - Within a macro
> - A function inside another function (a closure)
> - A generated function
Expand All @@ -127,6 +127,8 @@ Instability errors are also skipped during precompilation.
>
> You can safely use `@stable` over all of these cases, it will simply be ignored.
> Although, if you use `@stable` *internally* in any of these cases, (like calling `@stable` *within* a function on a closure), then it might still apply.
>
> Also, `@stable` has no effect on code in supported Julia versions.
## Credits

Expand Down

2 comments on commit 9cc1040

@MilesCranmer
Copy link
Owner Author

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 updated: JuliaRegistries/General/107632

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 v0.1.0 -m "<description of version>" 9cc104047c62dfe41ec8cdeff7c8e2785dc9b911
git push origin v0.1.0

Please sign in to comment.