[Lldb-commits] [PATCH] D101153: [lldb][NFC] Specify guidelines for API tests

[Diana Picus via Phabricator via lldb-commits]

rovka added a comment.

This is awesome, thanks for writing this up!



================
Comment at: lldb/docs/resources/test.rst:224
+    tests the `SBProcess`, `SBThread`, and `SBFrame` classes. The same is true
+    for tests that exercise to breakpoints, watchpoints and sanitizers.
+    Languages such as Objective-C that have a dependency on a runtime
----------------
I don't think you need 'to' here.


================
Comment at: lldb/docs/resources/test.rst:256
+**Identifiers in tests should be simple and descriptive.**
+    Often test program need to declare functions and classes which require
+    choosing some form of identifier for them. These identifiers should always
----------------
program -> programs


================
Comment at: lldb/docs/resources/test.rst:310
+    generate an explanation how the received values differ from the expected
+    ones. See the documentation of Python's `unittest` module to see what
+    asserts are available. If you can't find a specific assert that fits your
----------------
You're using 'see' twice in the same sentence. Some alternatives:
"Check the documentation [...]", 
"Read the documentation [...]", 
"[...] learn what asserts are available", 
or anything else along those lines :)


================
Comment at: lldb/docs/resources/test.rst:313
+    needs and you fall back to a generic assert, make sure you put useful
+    information into the assert's `msg` argument that help explain the failure.
+
----------------
help -> helps


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D101153/new/

https://reviews.llvm.org/D101153