You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To document an entire repository/directory include the `-r` (recursive) flag. The program generates a JSON file per code file with the documentation data; If you want to also add the documentation inside a copy of the code file, then please include the `-f` (fuse) flag. In case you already have the JSON docstrings, you can also fuse them separately using the corresponding [script](scripts/)
@@ -67,7 +60,7 @@ The `recursive` option allows you to document the entire repository. Alternative
67
60
68
61
## Cost
69
62
70
-
You can estimate project documentation costs using the `--estimate` flag with the `devtale` command, which won't make any GPT calls. Please note that this estimate is approximate, as it doesn't include GPT output tokens nor code items JSON tokens generated by the GPT call in the `devtale/utils.py/extract_code_elements` function.
63
+
You can estimate project documentation costs using the `--estimate` flag when using the `devtale` command in terminal, which won't make any GPT calls. Please note that this estimate is approximate, as it doesn't include GPT output tokens nor code items JSON tokens generated by the GPT call in the `devtale/utils.py/extract_code_elements` function.
71
64
72
65
If you skip the estimate and simply run 'devtale,' the final log will display the total cost. This total cost considers GPT output tokens and the tokens added by the code items JSON.
73
66
@@ -76,13 +69,13 @@ For example:
76
69
Running the following command:
77
70
78
71
```bash
79
-
python cli.py -r -f -p devtale/devtale --estimate
72
+
devtale -r -f -p devtale/devtale --estimate
80
73
```
81
74
82
75
will provide you with a cost estimate of $2.44733 USD. It won't document anything since it doesn't trigger any GPT calls. On the other hand, running:
83
76
84
77
```bash
85
-
python cli.py -r -f -p devtale/devtale
78
+
devtale -r -f -p devtale/devtale
86
79
```
87
80
88
81
will give you the total cost of $2.95762 USD. This command triggers GPT calls and, consequently, documents the directory.
0 commit comments