Skip to content

New version: SMLMData v0.4.0 #132375

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JuliaRegistrator
Copy link
Contributor

## Documentation improvements

- Add api() function that integrates API documentation into Julia's help system
- Users can now access comprehensive API docs via `?SMLMData.api` or `SMLMData.api()`
- Update module docstring to reference new documentation feature

UUID: 5488f106-40b8-4660-84c5-84a168990d1b
Repo: https://github.com/JuliaSMLM/SMLMData.jl.git
Tree: de6149ce7477c4ac25dfce692967d8b685e963cc

Registrator tree SHA: 17aec322677d9b81cdd6b9b9236b09a3f1374c6a
@kalidke
Copy link

kalidke commented Jun 5, 2025

stop

Copy link
Contributor

github-actions bot commented Jun 5, 2025

Hello, I am an automated registration bot. I help manage the registration process by checking your registration against a set of AutoMerge guidelines. If all these guidelines are met, this pull request will be merged automatically, completing your registration. It is strongly recommended to follow the guidelines, since otherwise the pull request needs to be manually reviewed and merged by a human.

1. AutoMerge Guidelines which are not met ❌

  • This is a breaking change, but the release notes do not mention it. Please add a mention of the breaking change to the release notes (use the words "breaking" or "changelog").

    Example of adding release notes with breaking notice

    If you are using the comment bot @JuliaRegistrator, you can add release notes to this registration by re-triggering registration while specifying release notes:

    @JuliaRegistrator register
    
    Release notes:
    
    ## Breaking changes
    
    - Explanation of breaking change, ideally with upgrade tips
    - ...
    

    If you are using JuliaHub, trigger registration the same way you did the first time, but enter release notes that specify the breaking changes.

    Either way, you need to mention the words "breaking" or "changelog", even if it is just to say "there are no breaking changes", or "see the changelog".

2. Needs action: here's what to do next

  1. Please try to update your package to conform to these guidelines. The General registry's README has an FAQ that can help figure out how to do so.
  2. After you have fixed the AutoMerge issues, simply retrigger Registrator, the same way you did in the initial registration. This will automatically update this pull request. You do not need to change the version number in your Project.toml file (unless the AutoMerge issue is that you skipped a version number).

If you need help fixing the AutoMerge issues, or want your pull request to be manually merged instead, please post a comment explaining what you need help with or why you would like this pull request to be manually merged. Then, send a message to the #pkg-registration channel in the public Julia Slack for better visibility.

3. To pause or stop registration

If you want to prevent this pull request from being auto-merged, simply leave a comment. If you want to post a comment without blocking auto-merging, you must include the text [noblock] in your comment.

Tip: You can edit blocking comments to add [noblock] in order to unblock auto-merging.

@JuliaTagBot JuliaTagBot added the AutoMerge: last run blocked by comment PR blocked by one or more comments lacking the string [noblock]. label Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AutoMerge: last run blocked by comment PR blocked by one or more comments lacking the string [noblock]. BREAKING minor release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants