tests + docs: made test_scheduling_info.py more readable + made sure doc tests generate correctly

Ramon Adolfo Arambula · Ramon Adolfo Arambula · commit e0ec1187d9fc · 2023-02-27T12:39:25.000-08:00
diff --git a/docs/user_guide.rst b/docs/user_guide.rst
@@ -298,7 +298,7 @@ Slurm // Local // LSF // PBS // Cobalt
 .. literalinclude:: ../tests/getting_started/test_scheduling_information.py
     :language: python
     :dedent: 4
-    :lines: 6-18
+    :lines: 7-20
 
 The `<QUEUE_NAME>` and `<ALLOCATION>` fields will depend on the system you are
 running on.
diff --git a/tests/getting_started/test_scheduling_information.py b/tests/getting_started/test_scheduling_information.py
@@ -11,7 +11,8 @@ def test_getting_started_scheduling_info(execparams: ExecutorTestParams) -> None
             executable="/bin/date",
             resources=ResourceSpecV1(node_count=1),
             # attributes=JobAttributes(
-            #     queue_name="<QUEUE_NAME>", project_name="<ALLOCATION>"
+            #     queue_name="<QUEUE_NAME>",
+            #     project_name="<ALLOCATION>"
             # ),
         )
     )

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,8 @@ def test_getting_started_scheduling_info(execparams: ExecutorTestParams) -> None`
`11`	`11`	`executable="/bin/date",`
`12`	`12`	`resources=ResourceSpecV1(node_count=1),`
`13`	`13`	`# attributes=JobAttributes(`
`14`		`- # queue_name="<QUEUE_NAME>", project_name="<ALLOCATION>"`
	`14`	`+ # queue_name="<QUEUE_NAME>",`
	`15`	`+ # project_name="<ALLOCATION>"`
`15`	`16`	`# ),`
`16`	`17`	`)`
`17`	`18`	`)`