Skip to content
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

Incorrect EffLeash example #6234

Closed
1 task done
Fusezion opened this issue Dec 15, 2023 · 3 comments
Closed
1 task done

Incorrect EffLeash example #6234

Fusezion opened this issue Dec 15, 2023 · 3 comments
Labels
completed The issue has been fully resolved and the change will be in the next Skript update. documentation Related to Skript's official documentation. patch-ready A PR/issue that has been approved and is ready to be merged/closed for the next patch version. priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements).

Comments

@Fusezion
Copy link
Contributor

Skript/Server Version

[00:42:39 INFO]: [Skript] Skript's aliases can be found here: https://github.com/SkriptLang/skript-aliases
[00:42:39 INFO]: [Skript] Skript's documentation can be found here: https://docs.skriptlang.org/
[00:42:39 INFO]: [Skript] Skript's tutorials can be found here: https://docs.skriptlang.org/tutorials
[00:42:39 INFO]: [Skript] Server Version: git-Paper-324 (MC: 1.20.4)
[00:42:39 INFO]: [Skript] Skript Version: 2.8.0-dev (selfbuilt-unknown)
[00:42:39 INFO]: [Skript] Installed Skript Addons:
[00:42:39 INFO]: [Skript]  - skript-gui v1.3 (https://github.com/APickledWalrus/skript-gui)
[00:42:39 INFO]: [Skript]  - skript-reflect v2.4-beta1 (https://github.com/SkriptLang/skript-reflect)
[00:42:39 INFO]: [Skript]  - SkBee v3.0.1 (https://github.com/ShaneBeee/SkBee)
[00:42:39 INFO]: [Skript] Installed dependencies: None

Bug Description

The given example for the leash effect is incorrect and will never work

Expected Behavior

A proper example showcasing how to use the effect and will work when tested

Steps to Reproduce

Look at example https://docs.skriptlang.org/effects.html?search=#EffLeash
or run example code in game.
leash the player to the target entity

Errors or Screenshots

This note on the method has been around since at least 1.12
image

Other

A note about what isn't included should be added alongside a new example

Agreement

  • I have read the guidelines above and affirm I am following them with this report.
@AyhamAl-Ali AyhamAl-Ali added documentation Related to Skript's official documentation. good first issue An issue that would be good for a first-time contributor to make a PR for labels Dec 16, 2023
@AyhamAl-Ali
Copy link
Member

I would also suggest adding that note to the description of the element (with reference to the latest method link, in case this behaviour is changed)

@AyhamAl-Ali AyhamAl-Ali added the priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements). label Dec 16, 2023
@Fusezion
Copy link
Contributor Author

Can I have this marked with completed and patch-ready label #6528 was merged already but didn't re-include this as a related issue.

@AyhamAl-Ali AyhamAl-Ali added the completed The issue has been fully resolved and the change will be in the next Skript update. label Apr 10, 2024
@AyhamAl-Ali
Copy link
Member

Done

@sovdeeth sovdeeth added patch-ready A PR/issue that has been approved and is ready to be merged/closed for the next patch version. and removed good first issue An issue that would be good for a first-time contributor to make a PR for labels Apr 14, 2024
@sovdeeth sovdeeth closed this as completed May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed The issue has been fully resolved and the change will be in the next Skript update. documentation Related to Skript's official documentation. patch-ready A PR/issue that has been approved and is ready to be merged/closed for the next patch version. priority: lowest "Nice to have" updates that are not required (tiny low impact bug fixes or QoL enhancements).
Projects
None yet
Development

No branches or pull requests

3 participants