8000 Make `@unreleased` mutually exclusive with `@deprecated` by EliTheGingerCat · Pull Request #167 · evaera/moonwave · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Make @unreleased mutually exclusive with @deprecated #167

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

Merged

Conversation

EliTheGingerCat
Copy link
Contributor

If something is unreleased, then it can not be deprecated, since deprecation is to mark something as not supported once it is already in use.

Relevant discussion: https://discord.com/channels/385151591524597761/894395472582676502/1348417437514858587

Other queries:

  1. I wonder why this was commented out of mutually exclusive pairs:
    // Field is exclusive with function
    // (TagType::Field, TagType::Function),
  1. There are a few cases where exclusive pairs involving @interface could be added, but this already errors due to "This tag is unused by X doc entries", which begs the question of whether explicit mutual exclusivity is really necessary.

Copy link
Collaborator
@YetAnotherClown YetAnotherClown Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this fits in this test file. This test file is for tags which aren't used on classes, when usage tags are something we could use on classes. It might be better to make a exclusive_tags test. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a test file dedicated to classes with unused tags is too specific. A general exclusive_tags.luau file would be better, though the file should still contain this test case with the class.

Copy link
Collaborator
@YetAnotherClown YetAnotherClown Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do agree, we'll leave the PR as it is and treat this test case as exclusive tags. I could rename the tests sometime, but I'm not too worried about that really.

@YetAnotherClown YetAnotherClown merged commit 0a6931a into evaera:master Mar 11, 2025
1 check passed
@EliTheGingerCat EliTheGingerCat deleted the fix-unreleased-deprecated branch March 11, 2025 23:20
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
0