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

Duplicate and possibly outdated documentation on running tests #1247

Open
6 tasks
jakob-keller opened this issue Dec 29, 2024 · 0 comments · May be fixed by #1248
Open
6 tasks

Duplicate and possibly outdated documentation on running tests #1247

jakob-keller opened this issue Dec 29, 2024 · 0 comments · May be fixed by #1248
Labels
documentation Improvements or additions to documentation

Comments

@jakob-keller
Copy link
Collaborator

jakob-keller commented Dec 29, 2024

Describe the bug
Both README.rst and CONTRIBUTING.rst contain sections on running tests. They appear to be contradictory. Wouldn't it make sense to remove that section from README.rst and update and/or elaborate CONTRIBUTING.rst?

Checklist

  • I have reproduced in environment where pip check passes without errors
  • I have provided pip freeze results
  • I have provided sample code or detailed way to reproduce
  • I have tried the same code in botocore to ensure this is an aiobotocore specific issue
  • I have tried similar code in aiohttp to ensure this is is an aiobotocore specific issue
  • I have checked the latest and older versions of aiobotocore/aiohttp/python to see if this is a regression / injection

pip freeze results

Environment:

  • Python Version: [e.g. 3.6]
  • OS name and version: [e.g. darwin stretch]

Additional context
Add any other context about the problem here.

@jakob-keller jakob-keller added the documentation Improvements or additions to documentation label Dec 29, 2024
@jakob-keller jakob-keller linked a pull request Dec 29, 2024 that will close this issue
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant