[7.4.x] Clarify docs for pytest.main default behavior (#11188)
Co-authored-by: antosikv <79337398+antosikv@users.noreply.github.com>
This commit is contained in:
		
							parent
							
								
									6dfe498c77
								
							
						
					
					
						commit
						06ff7ca13b
					
				| 
						 | 
					@ -173,7 +173,8 @@ You can invoke ``pytest`` from Python code directly:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
this acts as if you would call "pytest" from the command line.
 | 
					this acts as if you would call "pytest" from the command line.
 | 
				
			||||||
It will not raise :class:`SystemExit` but return the :ref:`exit code <exit-codes>` instead.
 | 
					It will not raise :class:`SystemExit` but return the :ref:`exit code <exit-codes>` instead.
 | 
				
			||||||
You can pass in options and arguments:
 | 
					If you don't pass it any arguments, ``main`` reads the arguments from the command line arguments of the process (:data:`sys.argv`), which may be undesirable.
 | 
				
			||||||
 | 
					You can pass in options and arguments explicitly:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.. code-block:: python
 | 
					.. code-block:: python
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -137,7 +137,9 @@ def main(
 | 
				
			||||||
) -> Union[int, ExitCode]:
 | 
					) -> Union[int, ExitCode]:
 | 
				
			||||||
    """Perform an in-process test run.
 | 
					    """Perform an in-process test run.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    :param args: List of command line arguments.
 | 
					    :param args:
 | 
				
			||||||
 | 
					        List of command line arguments. If `None` or not given, defaults to reading
 | 
				
			||||||
 | 
					        arguments directly from the process command line (:data:`sys.argv`).
 | 
				
			||||||
    :param plugins: List of plugin objects to be auto-registered during initialization.
 | 
					    :param plugins: List of plugin objects to be auto-registered during initialization.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    :returns: An exit code.
 | 
					    :returns: An exit code.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
		Reference in New Issue