Skip to content

Commit

Permalink
docs: Remove deprecated version annotation.
Browse files Browse the repository at this point in the history
  • Loading branch information
LisoUseInAIKyrios authored and oSumAtrIX committed Aug 19, 2023
1 parent 53fadf6 commit 6dc01f5
Showing 1 changed file with 2 additions and 8 deletions.
10 changes: 2 additions & 8 deletions docs/2_skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ package app.revanced.patches.ads.patch
@Name("Disable ads")
@Description("Disables ads.")
@DependsOn([DisableAdResourcePatch:class])
@Compatibility([Package("com.some.app", arrayOf("0.1.0"))])
@Version("0.0.1")
@Compatibility([Package("com.some.app", arrayOf("1.3.0"))])
class DisableAdsPatch : BytecodePatch(
listOf(LoadAdsFingerprint)
) {
Expand Down Expand Up @@ -48,8 +47,7 @@ Lets start with understanding, how a patch is structured. A patch is mainly buil
@Name("Disable Ads")
@Description("Disables ads.")
@DependsOn([DisableAdResourcePatch:class])
@Compatibility([Package("com.some.app", arrayOf("0.1.0"))])
@Version("0.0.1")
@Compatibility([Package("com.some.app", arrayOf("1.3.0"))])
```

To give context about the patch, annotations are used. They serve different but important purposes:
Expand All @@ -70,10 +68,6 @@ Lets start with understanding, how a patch is structured. A patch is mainly buil

Example: _The patch disables ads for an app. The app regularly updates and the code of the app mutates heavily. In that case the patch might not be compatible for future, untested versions of the app. To discourage the use of the app with other versions than the versions, this patch was confirmed to work on, it is constrained to those versions only._

- Patches can be annotated with `@Version`.

> Currently, this annotation does not serve any purpose, but is added to patches by convention, in case a use case has been found.
- Annotate a patch with `@RequiresIntegrations` if it depends on additional integrations to be merged by [ReVanced Patcher](https://github.com/revanced/revanced-patcher).

> Integrations are precompiled classes which are useful to off-load and useful for developing complex patches. Details of integrations and what exactly integrations are will be introduced properly on another page.
Expand Down

0 comments on commit 6dc01f5

Please sign in to comment.