Improve docs

vimeo · Feb 20, 2025 · 197f5e4 · 197f5e4
1 parent 049d352
commit 197f5e4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/bin/stubs/README.md b/bin/stubs/README.md
@@ -1,5 +1,3 @@
 # Working with the callmap
 
-```
-bin/gen_callmap.sh
-```
+See [here &raquo;](https://psalm.dev/docs/contributing/editing_callmaps/#intro).
diff --git a/docs/contributing/editing_callmaps.md b/docs/contributing/editing_callmaps.md
@@ -12,6 +12,10 @@ There is a partial callmap file in `dictionaries/override/CallMap.php` folder, a
 a number of delta files that provide information on
 how signatures changed in various PHP versions in `dictionaries/override/CallMap_*_delta.php`. 
 
+To alter info for a function, edit the signatures in `dictionaries/override/CallMap*` (adding the function if missing, copying it from `dictionaries/autogen/CallMap_$latest.php`).  
+
+When editing info for a function, don't forget to alter all revisions of the same function in `dictionaries/override/CallMap_*_delta.php`.
+
 The callmap files in the `override` subfolder are then used, in conjunction with the
 automatically-generated reflection callmaps in `dictionaries/autogen`, to generate the
 final callmaps in `dictionaries/CallMap_*`, which are the actual callmaps in use by Psalm.