Merge branch 'doc-development-gotchas' into 'master'

Docs: Update Gotchas page with comment clarifications

See merge request gitlab-org/gitlab!18593

doc/development/gotchas.md

@@ -114,6 +114,7 @@ Instead of writing:
 # Don't do this:
 expect_any_instance_of(Project).to receive(:add_import_job)
 
+# Don't do this:
 allow_any_instance_of(Project).to receive(:add_import_job)
 ```
 
@@ -125,6 +126,7 @@ expect_next_instance_of(Project) do |project|
   expect(project).to receive(:add_import_job)
 end
 
+# Do this:
 allow_next_instance_of(Project) do |project|
   allow(project).to receive(:add_import_job)
 end