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

fix: change variable name in bs.sidebar:create #301

Merged
merged 2 commits into from
Jan 12, 2025

Conversation

runoshun
Copy link
Contributor

@runoshun runoshun commented Jan 6, 2025

Description

Fixed the issue where bs.sidebar:create was not functioning correctly.

Related Issues

none

However, as far as I could confirm, it seemed that bs.sidebar/create was not functioning at all in either version 1.21.3 or 1.21.4.It appears that the variable name (a placeholder player name for the score) is conflicting with bs.sidebar:recurse/next.

Additional Notes

Tasks to complete before merging

  • I agree to release my contribution under the MPL v2 License.
  • My pull request is associated with an existing issue.
  • I have updated the changelog to reflect my contribution.
  • If this pull request adds or modifies a feature:
    • I have documented my changes in the /docs folder.
    • I have thoroughly tested my changes. See testing guidelines.

@aksiome
Copy link
Member

aksiome commented Jan 6, 2025

Thanks for catching this! The lack of proper unit tests for this module is already causing issues (sadly im not really sure it's possible to properly test it)... Could you update #len to another single letter that doesn’t conflict with existing variables? We have a convention to use single-letter names with the bs.ctx objective to minimize score usage. Also @theogiraudet do you think we should update the stable branch and create a 2.2.3, or keep this for the 3.0.0 update?

@runoshun
Copy link
Contributor Author

Thank you for your review!

I changed #len to #s. Regarding the release, I'm not in a hurry, so I'll leave the decision to you.
I made sure to include this change in the 3.0.0 changelog in the commit.
Please let me know if you need any further changes.

@aksiome
Copy link
Member

aksiome commented Jan 12, 2025

Since @theogiraudet also think it's best to wait for the 3.0.0. Im merging this now. Thanks again for the contribution !

@aksiome aksiome merged commit 6c5d6e5 into mcbookshelf:master Jan 12, 2025
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants