Browse Source

Add note about class reference generated XML descriptions

Co-Authored-By: A Thousand Ships <[email protected]>
(cherry picked from commit 67eff82f635536cb0cefb72bc6d58135288a4009)
Joel Kuntz 1 year ago
parent
commit
40a7154e4c
1 changed files with 2 additions and 0 deletions
  1. 2 0
      contributing/documentation/updating_the_class_reference.rst

+ 2 - 0
contributing/documentation/updating_the_class_reference.rst

@@ -110,3 +110,5 @@ Please only include changes that are relevant to your work on the API in your co
 You can discard changes in other XML files using ``git checkout``, but consider reporting
 if you notice unrelated files being updated. Ideally, running this command should only
 bring up the changes that you yourself have made.
+
+You will then need to add descriptions to any newly generated entries.