ソースを参照

update workflows

Ethosa 3 年 前
コミット
7edbf34850
2 ファイル変更5 行追加1 行削除
  1. 1 1
      .github/workflows/gh-pages.yml
  2. 4 0
      akane/akane.nim

+ 1 - 1
.github/workflows/gh-pages.yml

@@ -40,7 +40,7 @@ jobs:
           sudo apt update -yqq
 
       - name: Generate API documents
-        run: nimble doc --index:on --project --out:docs --hints:off akane/akane.nim
+        run: nimble doc --index:on --project --out:docs --hints:off -d:tools akane/akane.nim
 
       - name: Deploy documents
         uses: peaceiris/actions-gh-pages@v3

+ 4 - 0
akane/akane.nim

@@ -230,6 +230,8 @@ when defined(tools):
     ##
     ## Arguments:
     ## - `password` is an user password.
+    ##
+    ## WARNING! It's works only with `-d:tools`.
     return $secureHash(password)
   
   proc validatePassword*(password, hashpassword: string): Future[bool] {.async, inline.} =
@@ -238,6 +240,8 @@ when defined(tools):
     ## Arguments:
     ## - `password` is a got password from user input.
     ## - `hashpassword` is a response from `password2hash proc <#password2hash,string>`_
+    ##
+    ## WARNING! It's works only with `-d:tools`.
     return secureHash(password) == parseSecureHash(hashpassword)