Skip to content

Commit

Permalink
VIP - Add some docs of installer part
Browse files Browse the repository at this point in the history
  • Loading branch information
shahryarjb committed Jun 28, 2024
1 parent 120a290 commit 1218b2e
Show file tree
Hide file tree
Showing 6 changed files with 549 additions and 59 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,16 @@ jobs:
matrix:
include:
- pair:
elixir: "1.17.0"
elixir: "1.17.1"
otp: "27.0"

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4

- uses: erlef/setup-beam@v1
id: beam
with:
otp-version: ${{matrix.pair.otp}}
elixir-version: ${{matrix.pair.elixir}}
Expand Down
6 changes: 4 additions & 2 deletions lib/event/event.ex
Original file line number Diff line number Diff line change
Expand Up @@ -693,14 +693,16 @@ defmodule MishkaInstaller.Event.Event do
@doc """
To get all plugins ids from Mnesia database.
## Example:
> #### Security considerations {: .warning}
>
> It is important to remember that all of the functionalities contained within this
> section must be implemented at the **high access level**, and they should not directly take
> any input from the user. Ensure that you include the required safety measures.
## Example:
```elixir
ids()
```
Expand Down Expand Up @@ -830,7 +832,7 @@ defmodule MishkaInstaller.Event.Event do
end

@doc """
This function is exactly like `unique/2` function, except that its output is a Boolean
This function is exactly like `unique/2` function, except that its output is a Boolean.
> #### Security considerations {: .warning}
>
Expand Down
4 changes: 0 additions & 4 deletions lib/installer/compile_handler.ex
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,4 @@ defmodule MishkaInstaller.Installer.CompileHandler do
def handle_info(_action, state) do
{:noreply, state}
end

####################################################################################
########################## (▰˘◡˘▰) Helper (▰˘◡˘▰) ############################
####################################################################################
end
Loading

0 comments on commit 1218b2e

Please sign in to comment.