This repository was archived by the owner on Oct 12, 2022. It is now read-only.
Merged
Conversation
An alias for clear remains but is scheduled for deprecation.
Member
|
How about a changelog entry? |
Member
Author
|
I never mess with the changelog in pull requests, because it screws up merging far too easily. Assuming that this gets merged, I'll update the changelog then. |
Contributor
There was a problem hiding this comment.
Does having DDoc on aliases work? If so, this could probably be made a doc comment.
Contributor
There was a problem hiding this comment.
They don't; we have the same problem whenever we want to deprecate equals_t.
Member
Author
There was a problem hiding this comment.
Yes, they do work. For instance, DateTimeException is an alias for TimeException, and it shows up in the docs. I just didn't put ddoc on the alias, because clear wasn't actually documented in the first place.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
An alias for clear remains but is scheduled for deprecation.
As discussed in the newsgroup, we want to rename
clearto something else which is less likely to conflict with other functions and thus cause problems.destroywas a popular choice, so that's what I picked.I also added a ddoc comment to
destroywhich I hope is clear enough, butclearhas been undocumented, which it really shouldn't be, especially when we still unfortunately havedeletedocumented.