chylex/IntelliJ-IdeaVim
1
0
Fork 0
mirror of https://github.com/chylex/IntelliJ-IdeaVim.git synced 2025-03-06 00:32:52 +01:00
Code

Update vimBehaviourDiffers annotation description

Browse Source
This commit is contained in:
Alex Plate 2020-05-02 13:13:51 +03:00
parent bb133922d6
commit fb04e835ef
No known key found for this signature in database
GPG Key ID: 0B97153C8FFEC09F
1 changed files with 6 additions and 4 deletions

10
src/com/maddyhome/idea/vim/helper/Helper.kt
View File

@ -27,11 +27,11 @@ import java.util.*
/**
* This annotation is created for test functions (methods).
* It means that original vim behavior has small differences from behavior of IdeaVim.
* It means that the original vim behavior has small differences from behavior of IdeaVim.
* [shouldBeFixed] flag indicates whether the given functionality should be fixed
* or the given behavior is normal for IdeaVim and should be leaved as is.
*
* E.g. after execution some commands original vim has next text:
* E.g. after execution of some commands original vim has the following text:
* Hello1
* Hello2
* Hello3
@ -42,9 +42,11 @@ import java.util.*
* Hello2
* Hello3
*
* Why this annotation exists?
* In this case you should still create the test function and mark this function with [VimBehaviorDiffers] annotation.
*
* Why does this annotation exist?
* After creating some functionality you can understand that IdeaVim has a bit different behavior, but you
* cannot fix it right now because of any reasons (bugs in IDE,
* cannot fix it right now because of any reason (bugs in IDE,
* the impossibility of this functionality in IDEA (*[shouldBeFixed] == false*), leak of time for fixing).
* In that case, you should NOT remove the corresponding test or leave it without any marks that this test
* not fully convenient with vim, but leave the test with IdeaVim's behavior and put this annotation