Use Vale to lint docs writing (Qiskit/qiskit-ibm-runtime#739)

* Add writing linting with Vale * Lint docs using Vale rules Co-authored-by: Rebecca Dimock <[email protected]> * Add Vale tests to CI * Run black code formatting * Remove unneeded echo statements * Update PATH --------- Co-authored-by: Rebecca Dimock <[email protected]>
Qiskit · Oct 9, 2023 · be334cf · be334cf
1 parent adc0ff1
commit be334cf
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/runtime-docs/faqs/max_execution_time.rst b/runtime-docs/faqs/max_execution_time.rst
@@ -8,7 +8,7 @@ To ensure fairness, there is a maximum execution time for each Qiskit Runtime jo
 a job exceeds this time limit, it is forcibly cancelled. This is represented in the job
 status as `Cancelled - Ran too long`. The maximum execution time is the
 smaller of 1) the system limit and 2) the ``max_execution_time`` defined by the program.
-The system limit is defined below:
+The system limit is defined as follows:
 
 Qiskit Runtime on IBM Cloud
 ---------------------------
@@ -34,7 +34,7 @@ The system limit on the job execution time is
 Note that a *premium user* here means a user who has access to backends in providers other than ibm-q/open/main.
 
 
-Other Limitations
+Other limitations
 -----------------
 
 - Programs cannot exceed 750KB in size.

diff --git a/runtime-docs/faqs/open_source_vs_ibm_cloud_primitives.rst b/runtime-docs/faqs/open_source_vs_ibm_cloud_primitives.rst
@@ -1,8 +1,8 @@
 .. _faqs/open_source_vs_ibm_cloud_primitives:
 
-=================================================================================================
-What is the difference between the open source primitives and primitives available via IBM Cloud?
-=================================================================================================
+=====================================================================================================
+What is the difference between the open source primitives and primitives available through IBM Cloud?
+=====================================================================================================
 
 The open source primitive contains the base classes (to define interfaces) and a reference implementation.
 The Qiskit Runtime primitive is planned to provide more sophisticated implementation (such as with error