From 40a7154e4cd55ca13391377e1f83834bb5a09fa9 Mon Sep 17 00:00:00 2001 From: Joel Kuntz Date: Sat, 27 Apr 2024 10:21:03 -0300 Subject: [PATCH] Add note about class reference generated XML descriptions Co-Authored-By: A Thousand Ships <96648715+AThousandShips@users.noreply.github.com> (cherry picked from commit 67eff82f635536cb0cefb72bc6d58135288a4009) --- contributing/documentation/updating_the_class_reference.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributing/documentation/updating_the_class_reference.rst b/contributing/documentation/updating_the_class_reference.rst index dee882153..a16d4486d 100644 --- a/contributing/documentation/updating_the_class_reference.rst +++ b/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.