Skip to content

Commit 8bd3069

Browse files
committed
docs: update
1 parent e3f39a5 commit 8bd3069

File tree

3 files changed

+27
-8
lines changed

3 files changed

+27
-8
lines changed

docs/content/en/Development API/_index.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,20 @@ Points to `lisp` directory from the project root.
4343

4444
Return the current command in string.
4545

46+
## 🔍 Function: eask-special-p ()
47+
48+
Return `t` if the command that can be run without Eask-file existence.
49+
50+
This allow some commands can still be executed without defining the user
51+
directory. This can be handy when you want to do normal operations without
52+
touching the user directory.
53+
4654
## 🔍 Function: eask-checker-p ()
4755

48-
Return t if running Eask as the checker.
56+
Return `t` if running Eask as the checker.
57+
58+
Without this flag, the process will be terminated once the error is occured.
59+
This flag allows you to run through operations without report error.
4960

5061
## 🔍 Function: eask-script (`script`)
5162

@@ -224,7 +235,6 @@ Return `t` if the `strict` option is enabled.
224235
```
225236

226237
## 🔍 Function: eask-timestamps-p ()
227-
## 🔍 Function: eask-no-timestamps-p ()
228238

229239
Return `t`/`nil` if the `timestamps` option is enabled/disabled.
230240

@@ -236,7 +246,6 @@ These flags can't co-exist in the same command.
236246
```
237247

238248
## 🔍 Function: eask-log-level-p ()
239-
## 🔍 Function: eask-no-log-level-p ()
240249

241250
Return `t`/`nil` if the `log-level` option is enabled/disabled.
242251

@@ -545,17 +554,27 @@ global option.
545554
Like `message` function but will replace unicodes with color.
546555

547556
```elisp
548-
(eask-msg "This is a message")
557+
(eask-msg "Print this message with newline!")
549558
```
550559

551560
## 🔍 Function: eask-write (`msg` &rest `args`)
552561

553562
Like `eask-msg` function but without newline at the end.
554563

555564
```elisp
556-
(eask-write "This is a message")
565+
(eask-write "Print this message without newline...")
566+
```
567+
568+
## 🔍 Function: eask-report (&rest `args`)
569+
570+
Report error/warning depends on strict flag.
571+
572+
```elisp
573+
(eask-report "This can be warning or error")
557574
```
558575

576+
See option [--strict](https://emacs-eask.github.io/Getting-Started/Commands-and-options/#---strict)
577+
559578
# 🚩 File
560579

561580
## 🔍 Function: eask-guess-package-name ()

docs/content/en/Getting Started/Advanced Usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ You can do:
1212
(setq byte-compile-error-on-warn t) ; Signal error if warning occurred
1313
```
1414

15-
`eask` provides some hooks which enables you to execute code before and after
15+
`eask` provides some hooks which enable you to execute code before and after
1616
each command. The hooks look like so:
1717

1818
```elisp

docs/content/en/Getting Started/Directory Structure.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 350
66
{{< toc >}}
77

88
Running the **`eask create`** generator from the command-line will create
9-
a directory structure the following elements:
9+
a directory with the following structure:
1010

1111
```
1212
.
@@ -52,5 +52,5 @@ from your repository.
5252
`{package-file}.el`
5353

5454
This is the main package file; where you should write your elisp code.
55-
If you attempt to create a multiple file packages; you would need to
55+
If you attempt to create a multiple-file packages; you would need to
5656
edit the `Eask`-file accordingly.

0 commit comments

Comments
 (0)