Add breaking.md #9701
Add breaking.md #9701
Conversation
github-actions
bot
added
breaking change
|
|
||
| ### Doing operations not allowed on deleted sub directory | ||
| Users will not be allowed to do operations on a deleted directory. Users can subscribe to `disposed` event to know if a sub directory is deleted. Accessing deleted sub directory will throw `UsageError` exception now. | ||
|
|
||
| ### IDirectory extends IDisposable | ||
| IDirectory has started extending IDisposable. This means that users implementing the IDirectory interface needs to implement IDisposable too now. |
There was a problem hiding this comment.
just to confirm, is the plan to change the implements Partial<IDisposable> to implements IDisposable in the future?
| @@ -18,10 +18,14 @@ There are a few steps you can take to write a good change note and avoid needing | |||
|
|
|||
| ## 0.58 Upcoming changes | |||
There was a problem hiding this comment.
@heliocliu I would recommend changing this to not say 0.58, maybe "Upcoming changes (ETA 0.59)" or something. Or just "Upcoming changes" and as part of the release clear the section out every time...?
There was a problem hiding this comment.
I definitely wanted to avoid the step of needing to clear them out, but it's true that having a version associated with the upcoming change has been confusing for people :/ But yeah the ease of understanding probably outweighs needing to delete stuff occasionally there.
There was a problem hiding this comment.
Why would you need to clear them out?
Add in upcoming changes about IDirectory extending IDisposable.