[PATCH] D156858: Add Documentation for Execution Results Handling in Clang-REPL

[QuillPusher via Phabricator via cfe-commits]

QuillPusher requested changes to this revision.
QuillPusher added a comment.
This revision now requires changes to proceed.

added some comments for minor changes. Two sections to be removed since they are not yet merged to upstream code:

- Complex Data Types
- Users can create their own types



================
Comment at: clang/docs/ExecutionResultsHandling.rst:50-52
+Inspired by a similar implementation in `Cling <https://github.com/root-project/cling>`_,
+this feature added to upstream Clang repo has essentially extended the syntax of C++,
+so that it can be more helpful for people that are writing code for data science applications.
----------------
@Krishna-13-cyber  This paragraph is exceeding 80 columns. Please reformat to limit to 80 columns


================
Comment at: clang/docs/ExecutionResultsHandling.rst:55
+This is useful, for example, when you want to experiment with a set of values 
+against a set of functions, and you'd like to know the results right-away. 
+This is similar to how Python works (hence its popularity in data science 
----------------
Please remove the hyphen: 

right-away -> right away

(must have carried through from previous tool's preview)


================
Comment at: clang/docs/ExecutionResultsHandling.rst:257-259
+`Above is an example of interoperability between the compiled code and the 
+interpreted code. Interoperability between languages (e.g., C++ and Python) 
+works similarly.`
----------------
Formatting for this note seems different, it is enclosed in single quotes. Did you mean **Note:** or  " " ?


================
Comment at: clang/docs/ExecutionResultsHandling.rst:268
+
+How it works?
+---------------
----------------
Please remove the question mark, this is an expression, not a question (common mistake)

How it works? -> How it works

Note that another heading has a question mark (**Where is the captured result stored?**). That question mark is OK, since that is actually mimicking a user's question. So leave that one as it is.


================
Comment at: clang/docs/ExecutionResultsHandling.rst:283
+
+.. code-block:: console
+
----------------
@Krishna-13-cyber please add a note/comment above the code block:

Note: Following is a sample code snippet. Actual code may vary over time.


================
Comment at: clang/docs/ExecutionResultsHandling.rst:329-356
+
+Complex Data Types:
+-------------------
+
+This feature can print out primitive types (int, char, bool, etc.) easily. 
+For more complex types (e.g., `std::vector`), it falls back to a runtime 
+function call using the following helper function.
----------------
@Krishna-13-cyber please remove the "Complex Data Types" section, since this is not merged into the upstream LLVM code yet.
@junaire can confirm.


================
Comment at: clang/docs/ExecutionResultsHandling.rst:357-371
+
+Users can create their own types:
+---------------------------------
+
+All overloads live in a header, which are included at runtime. So **print a 
+std::vector** is equivalent to `PrintValueRuntime(&v);`.
+
----------------
@Krishna-13-cyber please remove the "Users can create their own types" section, since this is not merged into the upstream LLVM code yet.
@junaire can confirm.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D156858