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

Add deprecated version argument to the @Available directive #441

Open
QuietMisdreavus opened this issue Dec 15, 2022 · 7 comments · May be fixed by #851
Open

Add deprecated version argument to the @Available directive #441

QuietMisdreavus opened this issue Dec 15, 2022 · 7 comments · May be fixed by #851
Assignees
Labels
enhancement Improvements or enhancements to existing functionality good first issue Good for newcomers

Comments

@QuietMisdreavus
Copy link
Contributor

QuietMisdreavus commented Dec 15, 2022

Feature Name

Specify deprecated version in @Available directive

Description

The initial implementation of @Available (#440) only supports specifying the "introduced" version. We should add support for specifying a "deprecated" version as well.

Motivation

No response

Importance

No response

Alternatives Considered

No response

@d-ronnqvist
Copy link
Contributor

I would argue that we shouldn't add isBeta and isDeprecated arguments specifically because it makes @Available work completely different than in-source availability.

  • isBeta is an attribute of the current platform, which is provided via a command line argument
  • isDeprecated is a an attribute that's based on the version that the page is deprecated in. Instead we could add a deprecated version argument to match the introduced argument.

@d-ronnqvist d-ronnqvist changed the title Enable isBeta and isDeprecated in the @Available directive Add deprecated version argument to the @Available directive Dec 21, 2023
@d-ronnqvist d-ronnqvist added the good first issue Good for newcomers label Dec 21, 2023
@d-ronnqvist
Copy link
Contributor

Adding a new argument to an existing directive is a pretty good first task for someone who wants to learn about how directives work in DocC. There are existing tests for this type that can be updated to cover combinations of both arguments.

@mustiikhalil
Copy link

Hey, I am wondering if this is still open! I would love to pick it up and add the new directive into DocC.

@d-ronnqvist
Copy link
Contributor

@mustiikhalil yes, AFAIK this is still open and no-one has started working on it yet. That said, might be worth double checking with @sofiaromorales who is working on some other availability improvements.

@mustiikhalil
Copy link

That's perfect, I can pick it up after input from @sofiaromorales incase it's still needed.

@sofiaromorales
Copy link
Member

@mustiikhalil, sure, feel free to take on this issue 🙂

@mustiikhalil mustiikhalil linked a pull request Mar 5, 2024 that will close this issue
3 tasks
@mustiikhalil
Copy link

So I started working on it here #851 and from what I can see, I've implemented all the required fields for it to work as expected, however I wonder if I missed something.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvements or enhancements to existing functionality good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants