Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Deprecate drafts feature #8099
Deprecate drafts feature #8099
Changes from 1 commit
4a0b683
f699f0c
d8a6c8a
176dbc6
c2abd0b
056396f
4435deb
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@delucis - Is there any special formatting we need to adhere to for the
deprecated
entry here?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don’t actually display
@deprecated
comments in docs yet, so now’s our chance to decide a format if we want!I can imagine generating something like this? Where the contents of the comments follow the leading
Deprecated:
.Or even something like this depending on how highlighted we want it:
So given that, I guess it depends if you think specific wording would be clearest there @sarah11918?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, checking where I adopted the
since version X
pattern which is fromerrors-data.ts
, it looks like we already render it today:So perhaps another place to align if we want to make
@deprecated
work nicely everywhere.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah OK, yes, we could implement a similar pattern in the config reference if we like how the error generation script does this.
In this example I don’t love how basically a full sentence is split across heading and paragraph, so if we like the chunkier aside rendering, I would probably argue we should end up with something that looks more like:
In which case, best for that to be reflected in the JSDoc comment too:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I pushed a commit to update the
@deprecated
tag to be a proper sentence instead 👍