pxp9 · pxp9 · Feb 23, 2025 · Feb 22, 2025 · Feb 22, 2025 · Feb 22, 2025
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -86,6 +86,10 @@ jobs:
         run: mix credo --strict
         if: ${{ matrix.lint }}
 
+      - name: Run lazy_doc check
+        run: mix lazy_doc.check
+        if: ${{ matrix.lint }}
+
       - name: Run mix test
         run: mix test
 

diff --git a/README.md b/README.md
@@ -12,9 +12,6 @@ provider which is a tuple of two elements `{GithubAi, :codestral}`.
 - Customizable number of retries.
 - Custom paramters to pass the model (max\_tokens, top\_p, temperature).
 - Run mix format after writing the files, just in case.
-- Improve the default prompt to generate markdown syntax.
-- Make a task or an arg in the current task to check if the functions are
-  documented. (allows CI usage)
 
 ## Installation
 
@@ -63,9 +60,17 @@ mix lazy_doc
 
 I would recommend to run a `mix format` after just in case.
 
+If you want, you can add a simple check to see what needs to be documented in
+your project. This is good for CI.
+
+``` bash
+mix lazy_doc.check
+```
+
 ## Known limitations that wont be fixed.
 
 ### Module names in the same file must be different.
+
 If the user creates an inner module with the same name as the parent module
 `lazy_doc`, it wont work properly because they have the same `:__aliases__` AST
 node.

diff --git a/config/config.exs b/config/config.exs
@@ -12,6 +12,6 @@ config :lazy_doc, :provider, {GithubAi, :gpt_4o_mini}
 
 config :lazy_doc,
        :custom_function_prompt,
-       "You should describe the parameters based on the spec given and give a small description of the following function.\n\nPlease do it in the following format given as an example, important do not return the header of the function, do not return a explanation of the function, your output must be only the docs in the following format.\n\n@doc \"\"\"\n\nParameters\n\ntransaction_id - foreign key of the Transactions table.\nDescription\n Performs a search in the database\n\nReturns\n the Transaction corresponding to transaction_id\n\n\"\"\"\n\nFunction to document:\n"
+       ~s(You should describe the parameters based on the spec given and give a small description of the following function.\n\nPlease do it in the following format given as an example, important do not return the header of the function, do not return a explanation of the function, your output must be only the docs in the following format.\n\n@doc """\n\n## Parameters\n\n- transaction_id - foreign key of the Transactions table.\n## Description\n Performs a search in the database\n\n## Returns\n the Transaction corresponding to transaction_id\n\n"""\n\nFunction to document:\n)
 
 config :lazy_doc, :path_wildcard, "lib/**/*.ex"