Skip to content

Conversation

WildRikku
Copy link
Contributor

@WildRikku WildRikku commented Oct 17, 2024

  • Your PR targets OctoPrint's devel branch if it's a completely
    new feature, or maintenance if it's a bug fix or improvement of
    existing functionality for the current stable version (no PRs
    against master or anything else please)
  • Your PR was opened from a custom branch on your repository
    (no PRs from your version of master, maintenance, or devel
    please), e.g. dev/my_new_feature or fix/my_bugfix
  • Your PR only contains relevant changes: no unrelated files,
    no dead code, ideally only one commit - rebase and squash your PR
    if necessary!
  • Your changes follow the existing coding style
  • You have added yourself to the AUTHORS.md file :)

What does this PR do and why is it necessary?

adds missing doc. Stops users from staring at events in plugin code that are not in the list of events in the docs like I did :)

What are the relevant tickets if any?

I did not create one.

Further notes

I added the OctoPrint version in which the event was last changed. I have no idea what variables it might have used previously which are now deprecated so that section is missing. As those were never documented, I think that's ok.

@github-actions github-actions bot added docs Related to documentation targets dev The PR targets the dev branch approved Issue has been approved by the bot or manually for further processing labels Oct 17, 2024
WildRikku and others added 2 commits October 18, 2024 01:56
@foosel
Copy link
Member

foosel commented Oct 22, 2024

Thanks for that!

Quick hint, the easiest way to solve issues the the pre-commit step finds on the CI is to have it installed on your local check-out as well - it will then complain on the commit itself, and even fix it for you (at least in most of cases) so you can just add the changes to the commit.

See the developer docs.

@foosel foosel added this to the 1.11.0 milestone Oct 22, 2024
@foosel foosel merged commit 732e9af into OctoPrint:maintenance Oct 22, 2024
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Issue has been approved by the bot or manually for further processing docs Related to documentation targets dev The PR targets the dev branch
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants