Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Missing Docstrings and inline comments to pytest/src/_pytest/main.py (Lines 245-490) #12979

Open
LClarky opened this issue Nov 20, 2024 · 1 comment
Labels
type: docs documentation improvement, missing or needing clarification

Comments

@LClarky
Copy link

LClarky commented Nov 20, 2024

I noticed that several functions in the file pytest/src/_pytest/main.py, specifically between lines 245 and 490, are missing docstrings and inline comments. I propose adding Sphinx-compatible docstrings to all functions in the file pytest/src/_pytest/main.py between lines 245-490. Each docstring should:

  • Provide a brief overview of the function's purpose.
    
  • Detail the parameters, their types, and expected values.
    
  • Describe the return type and any possible return values.
    
  • Document any exceptions the function might raise.
    
  • inline comments should add 
    

I am open to submitting a pull request for this issue.

@nicoddemus
Copy link
Member

Sure, feel free to go ahead and open a PR. 👍

@Zac-HD Zac-HD added the type: docs documentation improvement, missing or needing clarification label Nov 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs documentation improvement, missing or needing clarification
Projects
None yet
Development

No branches or pull requests

3 participants